Class: Trello::Notification

Inherits:
BasicData show all
Defined in:
lib/trello/notification.rb

Instance Attribute Summary collapse

Attributes inherited from BasicData

#client

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BasicData

#==, client, create, #initialize, many, one, parse, parse_many, path_name, #refresh!, register_attributes, save

Methods included from JsonUtils

included

Constructor Details

This class inherits a constructor from Trello::BasicData

Instance Attribute Details

#data ⇒ Object

Returns:

  • (Object) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

#date ⇒ Datetime (readonly)

Returns:

  • (Datetime) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

#id ⇒ String (readonly)

Returns:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

#member_creator_id, ⇒ String (readonly)

Returns:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

#type ⇒ Object (readonly)

Returns:

  • (Object) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

#unread ⇒ Boolean Also known as: unread?

Returns:

  • (Boolean) 


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/trello/notification.rb', line 15

class Notification < BasicData
  register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
    read_only: [ :id, :unread, :type, :date, :member_creator_id ]
  validates_presence_of :id, :type, :date, :member_creator_id

  class << self
    # Locate a notification by its id
    def find(id, params = {})
      client.find(:notification, id, params)
    end
  end

  def update_fields(fields)
    attributes[:id]                = fields['id']
    attributes[:unread]            = fields['unread']
    attributes[:type]              = fields['type']
    attributes[:date]              = fields['date']
    attributes[:data]              = fields['data']
    attributes[:member_creator_id] = fields['idMemberCreator']
    self
  end

  alias :unread? :unread

  one :member_creator, path: :members, via: Member, using: :member_creator_id

  def board
    Board.from_response client.get("/notifications/#{id}/board")
  end

  def list
    List.from_response client.get("/notifications/#{id}/list")
  end

  def card
    Card.from_response client.get("/notifications/#{id}/card")
  end

  def member
    Member.from_response client.get("/notifications/#{id}/member")
  end

  def organization
    Organization.from_response client.get("/notifications/#{id}/organization")
  end
end

Class Method Details

.find(id, params = {}) ⇒ Object

Locate a notification by its id



22
23
24
 
# File 'lib/trello/notification.rb', line 22

def find(id, params = {})
  client.find(:notification, id, params)
end

Instance Method Details

#board ⇒ Object 



41
42
43
 
# File 'lib/trello/notification.rb', line 41

def board
  Board.from_response client.get("/notifications/#{id}/board")
end

#card ⇒ Object 



49
50
51
 
# File 'lib/trello/notification.rb', line 49

def card
  Card.from_response client.get("/notifications/#{id}/card")
end

#list ⇒ Object 



45
46
47
 
# File 'lib/trello/notification.rb', line 45

def list
  List.from_response client.get("/notifications/#{id}/list")
end

#member ⇒ Object 



53
54
55
 
# File 'lib/trello/notification.rb', line 53

def member
  Member.from_response client.get("/notifications/#{id}/member")
end

#organization ⇒ Object 



57
58
59
 
# File 'lib/trello/notification.rb', line 57

def organization
  Organization.from_response client.get("/notifications/#{id}/organization")
end

#update_fields(fields) ⇒ Object 



27
28
29
30
31
32
33
34
35
 
# File 'lib/trello/notification.rb', line 27

def update_fields(fields)
  attributes[:id]                = fields['id']
  attributes[:unread]            = fields['unread']
  attributes[:type]              = fields['type']
  attributes[:date]              = fields['date']
  attributes[:data]              = fields['data']
  attributes[:member_creator_id] = fields['idMemberCreator']
  self
end