module Instapaper::API::Folders

Defines methods related to folders

Public Instance Methods

add_folder(title) click to toggle source

Creates an organizational folder. @param title [String] The title of the folder to create

# File lib/instapaper/api/folders.rb, line 15
def add_folder(title)
  perform_post_with_object('/api/1.1/folders/add', {title: title}, Instapaper::Folder)
end
delete_folder(folder_id) click to toggle source

Deletes the folder and moves any articles in it to the Archive. @param folder_id [String] The id of the folder.

# File lib/instapaper/api/folders.rb, line 21
def delete_folder(folder_id)
  perform_post_with_unparsed_response('/api/1.1/folders/delete', folder_id: folder_id)
  true
end
folders() click to toggle source

List the account's user-created folders. @note This only includes organizational folders and does not include RSS-feed folders or starred-subscription folders

# File lib/instapaper/api/folders.rb, line 9
def folders
  perform_post_with_objects('/api/1.1/folders/list', {}, Instapaper::Folder)
end
set_order(order = []) click to toggle source

Re-orders a user's folders. @param order [Array] An array of folder_id:position pairs joined by commas. @example Ordering folder_ids 100, 200, and 300

Instapaper.set_order(['100:1','200:2','300:3'])
# File lib/instapaper/api/folders.rb, line 30
def set_order(order = []) # rubocop:disable Style/AccessorMethodName
  perform_post_with_objects('/api/1.1/folders/set_order', {order: order.join(',')}, Instapaper::Folder)
end