Class: Angus::SDoc::Definitions::MessageField

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

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Returns the description of the message field.

Returns:

  • (String) —

    the description of the message field.



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

def description
  @description
end

#elements_type ⇒ String

Returns the elements type of the message field.

Returns:

  • (String) —

    the elements type of the message field.



23
24
25
 
# File 'lib/angus/definitions/message_field.rb', line 23

def elements_type
  @elements_type
end

#name ⇒ String

Returns the name of the message field.

Returns:

  • (String) —

    the name of the message field.



7
8
9
 
# File 'lib/angus/definitions/message_field.rb', line 7

def name
  @name
end

#required ⇒ Boolean

Returns indicates if the message field. is required or not.

Returns:

  • (Boolean) —

    indicates if the message field. is required or not.



15
16
17
 
# File 'lib/angus/definitions/message_field.rb', line 15

def required
  @required
end

#type ⇒ String

Returns the type of the message field.

Returns:

  • (String) —

    the type of the message field.



19
20
21
 
# File 'lib/angus/definitions/message_field.rb', line 19

def type
  @type
end