Class: RubyAem::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_aem/result.rb

Overview

Result class represents the result of a client call. It contains the following attributes:

  • message: a message string containing the description of the result

  • response: a RubyAem::Response response from AEM

  • data: the data payload, which can be of any type depending on the API call

e.g. is_* and exists method provide result with boolean data. Some API calls result doesn’t contain any data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, response) ⇒ Object

Initialise a result.

Parameters:

  • message —

    result message

  • response —

    HTTP response



36
37
38
39
 
# File 'lib/ruby_aem/result.rb', line 36

def initialize(message, response)
  @message = message
  @response = response
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



29
30
31
 
# File 'lib/ruby_aem/result.rb', line 29

def data
  @data
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



27
28
29
 
# File 'lib/ruby_aem/result.rb', line 27

def message
  @message
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



28
29
30
 
# File 'lib/ruby_aem/result.rb', line 28

def response
  @response
end