Class: Ruqqus::Submission Abstract

Inherits:

ItemBase

• Object
• ItemBase
• Ruqqus::Submission

Defined in:

lib/ruqqus/types/submission.rb

Overview

This class is abstract.

Base class for Post and Comment types.

Direct Known Subclasses

Comment, Post

Instance Attribute Summary

• #author_name ⇒ String? readonly

  The name of the creator of the item, or nil if deleted account.

• #body ⇒ String readonly

  The text body of the item.

• #body_html ⇒ String readonly

  The text body of the item in HTML format.

• #downvotes ⇒ Integer readonly

  The number of downvotes this item has received.

• #fullname ⇒ String readonly

  The full ID of this item.

• #guild_name ⇒ String readonly

  The name of the guild this item is contained within.

• #last_edit ⇒ Time readonly

  The time of the last edit.

• #last_edit_utc ⇒ Integer readonly

  The time of the last edit in seconds since the Unix epoch, or 0 if never edited.

• #score ⇒ Integer readonly

  A score calculated by adding upvotes and subtracting downvotes.

• #title ⇒ String readonly

  The name/title of this item.

• #upvotes ⇒ Integer readonly

  The number of upvotes this item has received.

Attributes inherited from ItemBase

#created, #created_utc, #id, #permalink

Instance Method Summary

• #archived? ⇒ Boolean

  true if item has been archived, otherwise false.

• #deleted? ⇒ Boolean

  true if item has been deleted, otherwise false.

• #edited? ⇒ Boolean

  true if post has been edited, otherwise false.

• #nsfl? ⇒ Boolean

  true if item is adult content and flagged as NSFL, otheriwse false.

• #nsfw? ⇒ Boolean

  true if item is adult content and flagged as NSFW, otherwise false.

• #offensive? ⇒ Boolean

  true if item has been classified has offensive, otherwise false.

• #to_s ⇒ String

  The string representation of the object.

Methods inherited from ItemBase

#==, #banned?, from_json

Instance Attribute Details

#author_name ⇒ String? (readonly)

Returns the name of the creator of the item, or nil if deleted account.

Returns:

• (String?) —

  the name of the creator of the item, or nil if deleted account.

# File 'lib/ruqqus/types/submission.rb', line 13

#body ⇒ String (readonly)

Returns the text body of the item.

Returns:

• (String) —

  the text body of the item.

# File 'lib/ruqqus/types/submission.rb', line 17

#body_html ⇒ String (readonly)

Returns the text body of the item in HTML format.

Returns:

• (String) —

  the text body of the item in HTML format.

# File 'lib/ruqqus/types/submission.rb', line 21

#downvotes ⇒ Integer (readonly)

Returns the number of downvotes this item has received.

Returns:

• (Integer) —

  the number of downvotes this item has received.

# File 'lib/ruqqus/types/submission.rb', line 37

#fullname ⇒ String (readonly)

Returns the full ID of this item.

Returns:

• (String) —

  the full ID of this item.

# File 'lib/ruqqus/types/submission.rb', line 45

#guild_name ⇒ String (readonly)

Returns the name of the guild this item is contained within.

Returns:

• (String) —

  the name of the guild this item is contained within.

# File 'lib/ruqqus/types/submission.rb', line 49

#last_edit ⇒ Time (readonly)

Returns the time of the last edit.

Returns:

• (Time) —

  the time of the last edit.

# File 'lib/ruqqus/types/submission.rb', line 29

#last_edit_utc ⇒ Integer (readonly)

Returns the time of the last edit in seconds since the Unix epoch, or 0 if never edited.

Returns:

• (Integer) —

  the time of the last edit in seconds since the Unix epoch, or 0 if never edited.

# File 'lib/ruqqus/types/submission.rb', line 25

#score ⇒ Integer (readonly)

Returns a score calculated by adding upvotes and subtracting downvotes.

Returns:

• (Integer) —

  a score calculated by adding upvotes and subtracting downvotes.

# File 'lib/ruqqus/types/submission.rb', line 41

#title ⇒ String (readonly)

Returns the name/title of this item.

Returns:

• (String) —

  the name/title of this item.

# File 'lib/ruqqus/types/submission.rb', line 9

#upvotes ⇒ Integer (readonly)

Returns the number of upvotes this item has received.

Returns:

• (Integer) —

  the number of upvotes this item has received.

# File 'lib/ruqqus/types/submission.rb', line 33

Instance Method Details

#archived? ⇒ Boolean

Returns true if item has been archived, otherwise false.

Returns:

• (Boolean) —

  true if item has been archived, otherwise false.

# File 'lib/ruqqus/types/submission.rb', line 73

def archived?
  !!@data[:is_archived]
end

#deleted? ⇒ Boolean

Returns true if item has been deleted, otherwise false.

Returns:

• (Boolean) —

  true if item has been deleted, otherwise false.

# File 'lib/ruqqus/types/submission.rb', line 79

def deleted?
  !!@data[:is_deleted]
end

#edited? ⇒ Boolean

Returns true if post has been edited, otherwise false.

Returns:

• (Boolean) —

  true if post has been edited, otherwise false.

# File 'lib/ruqqus/types/submission.rb', line 55

def edited?
  @data[:edited_utc] != 0
end

#nsfl? ⇒ Boolean

Returns true if item is adult content and flagged as NSFL, otheriwse false.

Returns:

• (Boolean) —

  true if item is adult content and flagged as NSFL, otheriwse false.

# File 'lib/ruqqus/types/submission.rb', line 67

def nsfl?
  !!@data[:is_nsfl]
end

#nsfw? ⇒ Boolean

Returns true if item is adult content and flagged as NSFW, otherwise false.

Returns:

• (Boolean) —

  true if item is adult content and flagged as NSFW, otherwise false.

# File 'lib/ruqqus/types/submission.rb', line 61

def nsfw?
  !!@data[:is_nsfw]
end

#offensive? ⇒ Boolean

Returns true if item has been classified has offensive, otherwise false.

Returns:

• (Boolean) —

  true if item has been classified has offensive, otherwise false.

# File 'lib/ruqqus/types/submission.rb', line 85

def offensive?
  !!@data[:is_offensive]
end

#to_s ⇒ String

Returns the string representation of the object.

Returns:

• (String) —

  the string representation of the object.

# File 'lib/ruqqus/types/submission.rb', line 91

def to_s
  @data[:id]
end