Class: Angus::SDoc::Definitions::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/angus/definitions/message.rb

Constant Summary collapse

ERROR_LEVEL = 
'error'
INFO_LEVEL = 
'info'
WARNING_LEVEL = 
'warning'

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Returns the description of the message.

Returns:

  • (String) —

    the description of the message.



20
21
22
 
# File 'lib/angus/definitions/message.rb', line 20

def description
  @description
end

#fields ⇒ Array<Field>

Returns the fields for the message.

Returns:

  • (Array<Field>) —

    the fields for the message.



32
33
34
 
# File 'lib/angus/definitions/message.rb', line 32

def fields
  @fields
end

#key ⇒ String

Returns the key of the message. It is a human readable unique identifier. It has to start with Mayus and it has to be camelcase.

Returns:

  • (String) —

    the key of the message. It is a human readable unique identifier. It has to start with Mayus and it has to be camelcase.



16
17
18
 
# File 'lib/angus/definitions/message.rb', line 16

def key
  @key
end

#level ⇒ String

Returns the level of the message. Possible values are the *_LEVEL constants.

Returns:

  • (String) —

    the level of the message. Possible values are the *_LEVEL constants.



11
12
13
 
# File 'lib/angus/definitions/message.rb', line 11

def level
  @level
end

#status_code ⇒ String

Returns the HTTP status code of the message.

Returns:

  • (String) —

    the HTTP status code of the message.



24
25
26
 
# File 'lib/angus/definitions/message.rb', line 24

def status_code
  @status_code
end

#text ⇒ String

Returns when set this text overrides all others and is set as the message description.

Returns:

  • (String) —

    when set this text overrides all others and is set as the message description.



28
29
30
 
# File 'lib/angus/definitions/message.rb', line 28

def text
  @text
end