Class: X::BookmarkFolder

Inherits:

Resource

• Object
• Resource
• X::BookmarkFolder

Defined in:

x-objects/lib/x/objects/bookmark_folder.rb

Overview

A folder the authenticated user keeps bookmarks in

The API offers no lookup of a folder, so a folder is read from the bookmark folders of the user it belongs to, which X::User#bookmark_folders pages through, and the class answers no finder. from_id builds one from its identifier, which X::User#bookmarks takes as the folder to read the posts of, but hydrate and refresh raise UnsupportedOperation for one that is not hydrated, since there is nothing to look it up with.

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of the folder.

Constructor Details

This class inherits a constructor from X::Resource

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of the folder

Examples:

Get the name

folder.name # => "Ruby"

Returns:

• (String, nil) —

  the name

# File 'x-objects/lib/x/objects/bookmark_folder.rb', line 21

attribute :name