Module: Redd::Clients::Base::Wikiread

Included in:
Redd::Clients::Base
Defined in:
lib/redd/clients/base/wikiread.rb

Overview

Note:

This method is not limited to Objects::Subreddit because there are also top-level wiki pages.

Methods that require the “wikiread” scope.

Instance Method Summary collapse

Instance Method Details

#get_wikipages(subreddit = nil) ⇒ Array<String>

Get a list of pages in the subreddit wiki.

Parameters:

Returns:

  • (Array<String>) —

    An array of wikipage titles.



12
13
14
15
16
17
 
# File 'lib/redd/clients/base/wikiread.rb', line 12

def get_wikipages(subreddit = nil)
  path = '/wiki/pages.json'
  name = property(subreddit, :display_name)
  path.prepend("/r/#{name}") if subreddit
  get(path).body[:data]
end

#wikipage(page, subreddit = nil) ⇒ Objects::WikiPage

Get a wiki page.

Parameters:

  • page (String) —

    The title of the wiki page.

  • subreddit (Objects::Subreddit, String) (defaults to: nil) —

    The subreddit to look in.

Returns:



24
25
26
27
28
29
 
# File 'lib/redd/clients/base/wikiread.rb', line 24

def wikipage(page, subreddit = nil)
  path = "/wiki/#{page}.json"
  name = property(subreddit, :display_name)
  path.prepend("/r/#{name}") if subreddit
  request_object(:get, path)
end