Class: Zernio::RedditPlatformData

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

Overview

Posts are either link (with URL/media), native video (via nativeVideo), or self (text-only). Use forceSelf to override. Subreddit defaults to the account's configured one. Some subreddits require a flair.

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 = {}) ⇒ RedditPlatformData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::RedditPlatformData` 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::RedditPlatformData`. 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?(:'subreddit')
    self.subreddit = attributes[:'subreddit']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'sendreplies')
    self.sendreplies = attributes[:'sendreplies']
  else
    self.sendreplies = true
  end

  if attributes.key?(:'native_video')
    self.native_video = attributes[:'native_video']
  else
    self.native_video = true
  end

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

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

Instance Attribute Details

#flair_id ⇒ Object

Flair ID for the post. Required by some subreddits. Use GET /v1/accounts/id/reddit-flairs?subreddit=name to list flairs.



32
33
34
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 32

def flair_id
  @flair_id
end

#flair_text ⇒ Object

Custom flair text, for subreddits that allow free-text flair. Ignored when flairId is provided (flairId wins).



35
36
37
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 35

def flair_text
  @flair_text
end

#force_self ⇒ Object

When true, creates a text/self post even when a URL or media is provided.



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

def force_self
  @force_self
end

#native_video ⇒ Object

Controls Reddit's native video upload flow. When true (default for video mediaItems), the video is uploaded to Reddit's CDN and submitted with kind=video so it renders as an embedded Reddit video player. Reddit transcodes server-side (1080p/30fps cap). Set to false to fall back to a legacy link post. If the subreddit blocks video posts, the upload falls back to a link post automatically.



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

def native_video
  @native_video
end

#nsfw ⇒ Object

Mark the post as NSFW (Not Safe For Work / over 18).



38
39
40
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 38

def nsfw
  @nsfw
end

#sendreplies ⇒ Object

Whether to receive inbox replies for comments on this post. Set to false to opt out.



44
45
46
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 44

def sendreplies
  @sendreplies
end

#spoiler ⇒ Object

Mark the post as a spoiler. The subreddit must have spoiler tagging enabled for this to take effect.



41
42
43
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 41

def spoiler
  @spoiler
end

#subreddit ⇒ Object

Target subreddit name (without "r/" prefix). Overrides the default. Use GET /v1/accounts/id/reddit-subreddits to list options.



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

def subreddit
  @subreddit
end

#title ⇒ Object

Post title. Defaults to the first line of content, truncated to 300 characters.



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

def title
  @title
end

#url ⇒ Object

URL for link posts. If provided (and forceSelf is not true), creates a link post instead of a text post.



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

def url
  @url
end

#video_poster_url ⇒ Object

Optional poster/thumbnail image URL for native video posts. If omitted, the first frame of the video is extracted and used automatically.



53
54
55
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 53

def video_poster_url
  @video_poster_url
end

#videogif ⇒ Object

When true (and nativeVideo is active), submits the video as a silent videogif (kind=videogif). Use for short looping clips without audio.



50
51
52
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 50

def videogif
  @videogif
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 56

def self.attribute_map
  {
    :'subreddit' => :'subreddit',
    :'title' => :'title',
    :'url' => :'url',
    :'force_self' => :'forceSelf',
    :'flair_id' => :'flairId',
    :'flair_text' => :'flairText',
    :'nsfw' => :'nsfw',
    :'spoiler' => :'spoiler',
    :'sendreplies' => :'sendreplies',
    :'native_video' => :'nativeVideo',
    :'videogif' => :'videogif',
    :'video_poster_url' => :'videoPosterUrl'
  }
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 248

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



102
103
104
105
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 84

def self.openapi_types
  {
    :'subreddit' => :'String',
    :'title' => :'String',
    :'url' => :'String',
    :'force_self' => :'Boolean',
    :'flair_id' => :'String',
    :'flair_text' => :'String',
    :'nsfw' => :'Boolean',
    :'spoiler' => :'Boolean',
    :'sendreplies' => :'Boolean',
    :'native_video' => :'Boolean',
    :'videogif' => :'Boolean',
    :'video_poster_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subreddit == o.subreddit &&
      title == o.title &&
      url == o.url &&
      force_self == o.force_self &&
      flair_id == o.flair_id &&
      flair_text == o.flair_text &&
      nsfw == o.nsfw &&
      spoiler == o.spoiler &&
      sendreplies == o.sendreplies &&
      native_video == o.native_video &&
      videogif == o.videogif &&
      video_poster_url == o.video_poster_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


235
236
237
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 241

def hash
  [subreddit, title, url, force_self, flair_id, flair_text, nsfw, spoiler, sendreplies, native_video, videogif, video_poster_url].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



182
183
184
185
186
187
188
189
190
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 182

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 300
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 300.')
  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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 270

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



194
195
196
197
198
 
# File 'lib/zernio-sdk/models/reddit_platform_data.rb', line 194

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 300
  true
end