Class: Forem::ReadingList

Inherits:

APIResource

• Object
• ForemObject
• APIResource
• Forem::ReadingList

Extended by:

APIOperations::List

Defined in:

lib/forem/resources/reading_list.rb

Overview

Represents an item saved to the authenticated user's reading list.

When a user bookmarks an article on Forem, it appears in their reading list. This resource supports listing those saved articles with optional filtering by status.

Requires authentication. Returns articles saved to the user's reading list. Default: 30 per page.

Available operations (via mixins):

- +List+ — GET /api/readinglist

Examples:

List all bookmarked articles

items = client.reading_list.list
items.data.each { |item| puts item.article.title }

List only confirmed (active) reading list items

items = client.reading_list.list(status: "confirmed")
items.data.each { |item| puts item.article.title }

See Also:

• https://developers.forem.com/api/v1#/operations/getReadinglist

Constant Summary

OBJECT_NAME =

"reading_list"

RESOURCE_PATH =

"/api/readinglist"

Instance Attribute Summary

Attributes inherited from ForemObject

#requestor

Method Summary

Methods included from APIOperations::List

list

Methods inherited from APIResource

#refresh, resource_path, #resource_url

Methods inherited from ForemObject

#==, #[], #[]=, construct_from, cursor_list, #initialize, #inspect, #method_missing, paginated_list, #respond_to_missing?, #to_hash

Methods included from APIOperations::Request

included, #request

Constructor Details

This class inherits a constructor from Forem::ForemObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Forem::ForemObject