Class: LWS::Resource::Collection

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/resource.rb

Overview

The collection class

There are two ways to view collections. Either it is viewed as a set of items (see #items), or it is viewed as something that is associated with one or more meta collections that each have specific item objects (see for example #feed, #image, #images, etc.).

Defined Under Namespace

Classes: Config, Feed, Image, Item, Post, Video, Vimeo, WeatherLocation, YouTube

Collection Items Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from Generic::Model

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

Method Summary

Methods inherited from Generic::Model

#deep_dup, #dig, #reload, #rollback, #save

Instance Attribute Details

#account ⇒ LWS::Auth::Account

Returns the account of the user that created the collection.

Returns:



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

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

#account_id ⇒ Integer

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

Returns:

  • (Integer) —

    the ID of the account of the user that created the collection



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

attribute :account_id

#company ⇒ LWS::Auth::Company

Returns the company the collection belongs to.

Returns:



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

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

#company_id ⇒ Integer

Returns the ID of the company the collection belongs to.

Returns:

  • (Integer) —

    the ID of the company the collection belongs to



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

attribute :company_id

#config ⇒ Collection::Config

Returns the configuration that is part of the collection (if kind is :config).

Returns:

  • (Collection::Config) —

    the configuration that is part of the collection (if kind is :config)



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

has_one :config

#deleted_at ⇒ String?

Returns the timestamp of when the collection was deleted.

Returns:

  • (String, nil) —

    the timestamp of when the collection was deleted



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

attribute :deleted_at

#description ⇒ String

Returns the description of the collection.

Returns:

  • (String) —

    the description of the collection



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

attribute :description

#email ⇒ String?

Returns the email address used for email imports.

Returns:

  • (String, nil) —

    the email address used for email imports



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

attribute :email

#feed ⇒ Collection::Feed

Returns the feed that is part of the collection (if kind is :feed).

Returns:

  • (Collection::Feed) —

    the feed that is part of the collection (if kind is :feed)



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

has_one :feed

#feeds ⇒ Array<Collection::Feed>

Returns the feeds that are part of the collection (if kind is :feeds).

Returns:

  • (Array<Collection::Feed>) —

    the feeds that are part of the collection (if kind is :feeds)



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

has_many :feeds

#folder ⇒ Folder

Returns the folder that the collection is filed in.

Returns:

  • (Folder) —

    the folder that the collection is filed in



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

belongs_to :folder

#folder_id ⇒ Integer

Returns the ID of the folder that the collection is filed in.

Returns:

  • (Integer) —

    the ID of the folder that the collection is filed in



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

attribute :folder_id

#image ⇒ Collection::Image

Returns the image that is part of the collection (if kind is :image).

Returns:

  • (Collection::Image) —

    the image that is part of the collection (if kind is :image)



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

has_one :image

#images ⇒ Array<Collection::Image>

Returns the images that are part of the collection (if kind is :images).

Returns:

  • (Array<Collection::Image>) —

    the images that are part of the collection (if kind is :images)



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

has_many :images

#items ⇒ Collection::Item

The returned object are of a class that is determined by the kind of this collection.

Returns:



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

has_many :items, class_name: "LWS::Resource::Collection::Item"

#kind ⇒ "feed", ...

Returns the name of the class/kind of the collection.

Returns:



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

attribute :kind

#name ⇒ String

Returns the name of the collection.

Returns:

  • (String) —

    the name of the collection



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

attribute :name

#powerpoint ⇒ Collection::PowerPoint

Returns the PowerPoint presentation that is part of the collection (if kind is :powerpoint).

Returns:

  • (Collection::PowerPoint) —

    the PowerPoint presentation that is part of the collection (if kind is :powerpoint)



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

has_one :powerpoint

#preview_url ⇒ String

Returns the URL of a preview of the collection.

Returns:

  • (String) —

    the URL of a preview of the collection



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

attribute :preview_url

#processing ⇒ Boolean

Returns whether the collection is being processed (i.e. it is not ready for use).

Returns:

  • (Boolean) —

    whether the collection is being processed (i.e. it is not ready for use)



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

attribute :processing

#uuid ⇒ String

Returns the UUID used for unique file name generation.

Returns:

  • (String) —

    the UUID used for unique file name generation



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

attribute :uuid

#video ⇒ Collection::Video

Returns the video that is part of the collection (if kind is :video).

Returns:

  • (Collection::Video) —

    the video that is part of the collection (if kind is :video)



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

has_one :video

#videos ⇒ Array<Collection::Video>

Returns the videos that are part of the collection (if kind is :videos).

Returns:

  • (Array<Collection::Video>) —

    the videos that are part of the collection (if kind is :videos)



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

has_many :videos

#vimeo ⇒ Collection::Vimeo

Returns the Vimeo video that is part of the collection (if kind is :vimeo).

Returns:

  • (Collection::Vimeo) —

    the Vimeo video that is part of the collection (if kind is :vimeo)



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

has_one :vimeo

#vimeos ⇒ Array<Collection::Vimeo>

Returns the Vimeo videos that are part of the collection (if kind is :vimeos).

Returns:

  • (Array<Collection::Vimeo>) —

    the Vimeo videos that are part of the collection (if kind is :vimeos)



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

has_many :vimeos

#weather_location ⇒ Collection::WeatherLocation

Returns the weather collection that is part of the collection (if kind is :weather_location).

Returns:



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

has_one :weather_location

#youtube ⇒ Collection::YouTube

Returns the YouTube video that is part of the collection (if kind is :youtube).

Returns:

  • (Collection::YouTube) —

    the YouTube video that is part of the collection (if kind is :youtube)



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

has_one :youtube

#youtubes ⇒ Array<Collection::YouTube>

Returns the YouTube videos that are part of the collection (if kind is :youtubes).

Returns:

  • (Array<Collection::YouTube>) —

    the YouTube videos that are part of the collection (if kind is :youtubes)



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

has_many :youtubes