Class: Basecamp3::Inbox

Inherits:
Model
  • Object
show all
Includes:
Concerns::Bucketable, Concerns::Creatorable
Defined in:
lib/basecamp3/models/inbox.rb

Overview

A model for Basecamp's Inbox

For more information, see the official Basecamp3 API documentation for Inboxes

Constant Summary

Constants inherited from Model

Model::REQUIRED_FIELDS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::Bucketable

#bucket

Methods included from Concerns::Creatorable

#creator

Methods inherited from Model

#initialize

Constructor Details

This class inherits a constructor from Basecamp3::Model

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def created_at
  @created_at
end

#forwards_count ⇒ Object

Returns the value of attribute forwards_count



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def forwards_count
  @forwards_count
end

#id ⇒ Object

Returns the value of attribute id



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def id
  @id
end

#status ⇒ Object

Returns the value of attribute status



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def status
  @status
end

#title ⇒ Object

Returns the value of attribute title



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def title
  @title
end

#updated_at ⇒ Object

Returns the value of attribute updated_at



8
9
10
 
# File 'lib/basecamp3/models/inbox.rb', line 8

def updated_at
  @updated_at
end

Class Method Details

.find(bucket_id, id) ⇒ Basecamp3::Inbox

Returns the inbox.

Parameters:

  • bucket_id (Integer) —

    the id of the bucket

  • id (Integer) —

    the id of the inbox

Returns:



28
29
30
 
# File 'lib/basecamp3/models/inbox.rb', line 28

def self.find(bucket_id, id)
  Basecamp3.request.get("/buckets/#{bucket_id}/inboxes/#{id}", {}, Basecamp3::Inbox)
end

Instance Method Details

#forwards ⇒ Array<Basecamp3::Forward>

Returns a list of related forwards.

Returns:



18
19
20
 
# File 'lib/basecamp3/models/inbox.rb', line 18

def forwards
  @mapped_forwards ||= Basecamp3::Forward.all(bucket.id, id)
end