Class: LWS::Resource::Folder

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::Resource::Folder

Defined in:

lib/lws/apps/resource.rb

Overview

The folder class

Instance Attribute Summary

• #account ⇒ LWS::Auth::Account

  The account of the user that created the folder.

• #account_id ⇒ Integer

  The ID of the account of the user that created the folder.

• #collections ⇒ Array<Collection>

  The collections filed in the folder.

• #company ⇒ LWS::Auth::Company

  The company the folder belongs to.

• #company_id ⇒ Integer

  The ID of the company the folder belongs to.

• #deleted_at ⇒ String^?

  The timestamp of when the folder was deleted.

• #description ⇒ String

  The description of the folder.

• #favourite ⇒ Boolean

  Flag whether the folder is considered as a favourite.

• #folders ⇒ Array<Folder>

  The folders contained in the folder.

• #name ⇒ String

  The name of the folder.

• #parent ⇒ Folder^?

  The parent folder of the folder.

• #parent_id ⇒ Integer^?

  The ID of the parent folder of the folder.

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#dig, #reload, #rollback, #save

Instance Attribute Details

#account ⇒ LWS::Auth::Account

Returns the account of the user that created the folder.

Returns:

• (LWS::Auth::Account) —

  the account of the user that created the folder

# File 'lib/lws/apps/resource.rb', line 493

belongs_to :account, class_name: "LWS::Auth::Account"

#account_id ⇒ Integer

Returns the ID of the account of the user that created the folder.

Returns:

• (Integer) —

  the ID of the account of the user that created the folder

# File 'lib/lws/apps/resource.rb', line 498

attribute :account_id

#collections ⇒ Array<Collection>

Returns the collections filed in the folder.

Returns:

• (Array<Collection>) —

  the collections filed in the folder

# File 'lib/lws/apps/resource.rb', line 502

has_many :collections

#company ⇒ LWS::Auth::Company

Returns the company the folder belongs to.

Returns:

• (LWS::Auth::Company) —

  the company the folder belongs to

# File 'lib/lws/apps/resource.rb', line 506

belongs_to :company, class_name: "LWS::Auth::Company"

#company_id ⇒ Integer

Returns the ID of the company the folder belongs to.

Returns:

• (Integer) —

  the ID of the company the folder belongs to

# File 'lib/lws/apps/resource.rb', line 510

attribute :company_id

#deleted_at ⇒ String^?

Returns the timestamp of when the folder was deleted.

Returns:

• (String, nil) —

  the timestamp of when the folder was deleted

# File 'lib/lws/apps/resource.rb', line 514

attribute :deleted_at

#description ⇒ String

Returns the description of the folder.

Returns:

• (String) —

  the description of the folder

# File 'lib/lws/apps/resource.rb', line 518

attribute :description

#favourite ⇒ Boolean

Returns flag whether the folder is considered as a favourite.

Returns:

• (Boolean) —

  flag whether the folder is considered as a favourite

# File 'lib/lws/apps/resource.rb', line 526

attribute :favourite

#folders ⇒ Array<Folder>

Returns the folders contained in the folder.

Returns:

• (Array<Folder>) —

  the folders contained in the folder

# File 'lib/lws/apps/resource.rb', line 522

has_many :folders

#name ⇒ String

Returns the name of the folder.

Returns:

• (String) —

  the name of the folder

# File 'lib/lws/apps/resource.rb', line 530

attribute :name

#parent ⇒ Folder^?

Returns the parent folder of the folder.

Returns:

• (Folder, nil) —

  the parent folder of the folder

# File 'lib/lws/apps/resource.rb', line 534

belongs_to :parent, class_name: "LWS::Resource::Folder",
foreign_key: "parent_id"

#parent_id ⇒ Integer^?

Returns the ID of the parent folder of the folder.

Returns:

• (Integer, nil) —

  the ID of the parent folder of the folder

# File 'lib/lws/apps/resource.rb', line 539

attribute :parent_id