Class: Clockwork::SMS::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/clockwork/sms/response.rb

Overview

A Clockwork::SMS::Response is returned for each SMS sent by Clockwork::SMS#deliver.

Author:

  • James Inman <james@mediaburst.co.uk>

Instance Attribute Summary collapse

Instance Attribute Details

#error_codestring

The error code returned if the SMS fails.

Returns:

  • (string)


11
12
13
# File 'lib/clockwork/sms/response.rb', line 11

def error_code
  @error_code
end

#error_descriptionstring

The error description returned if the SMS fails.

Returns:

  • (string)


16
17
18
# File 'lib/clockwork/sms/response.rb', line 16

def error_description
  @error_description
end

#messageClockwork::SMS

The instance of Clockwork::SMS relating to this response.

Returns:



26
27
28
# File 'lib/clockwork/sms/response.rb', line 26

def message
  @message
end

#message_idstring

The message ID returned if the SMS is sent successfully.

Returns:

  • (string)


21
22
23
# File 'lib/clockwork/sms/response.rb', line 21

def message_id
  @message_id
end

#successboolean

true if the SMS is sent successfully, false otherwise.

Returns:

  • (boolean)


31
32
33
# File 'lib/clockwork/sms/response.rb', line 31

def success
  @success
end