Class: EveOnline::ESI::CharacterMailLabels

Inherits:
Base
  • Object
show all
Defined in:
lib/eve_online/esi/character_mail_labels.rb

Constant Summary collapse

API_PATH = 
"/v3/characters/%<character_id>s/mail/labels/"

Constants inherited from Base

Base::API_HOST

Instance Attribute Summary collapse

Attributes inherited from Base

#_open_timeout, #_read_timeout, #_write_timeout, #adapter, #language, #middlewares, #token

Instance Method Summary collapse

Methods inherited from Base

#add_middleware, #additional_query_params, #base_query_params, #connection, #error_limit_remain, #error_limit_reset, #http_method, #open_timeout, #open_timeout=, #page, #query, #read_timeout, #read_timeout=, #request_id, #resource, #response, #total_pages, #uri, #url, #user_agent, #write_timeout, #write_timeout=

Constructor Details

#initialize(options) ⇒ CharacterMailLabels

Returns a new instance of CharacterMailLabels.



10
11
12
13
14
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 10

def initialize(options)
  super

  @character_id = options.fetch(:character_id)
end

Instance Attribute Details

#character_id ⇒ Object (readonly)

Returns the value of attribute character_id.



8
9
10
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 8

def character_id
  @character_id
end

Instance Method Details

#labels ⇒ Object 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 16

def labels
  @labels ||=
    begin
      output = []
      response.fetch("labels").each do |label|
        output << Models::MailLabel.new(label)
      end
      output
    end
end

#path ⇒ Object 



35
36
37
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 35

def path
  format(API_PATH, character_id: character_id)
end

#scope ⇒ Object 



31
32
33
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 31

def scope
  "esi-mail.read_mail.v1"
end

#total_unread_count ⇒ Object 



27
28
29
 
# File 'lib/eve_online/esi/character_mail_labels.rb', line 27

def total_unread_count
  response["total_unread_count"]
end