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:

Instance Attribute Summary (collapse)

Instance Attribute Details

- (string) error_code

The error code returned if the SMS fails.



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

def error_code
  @error_code
end

- (string) error_description

The error description returned if the SMS fails.



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

def error_description
  @error_description
end

- (Clockwork::SMS) message

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



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

def message
  @message
end

- (string) message_id

The message ID returned if the SMS is sent successfully.



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

def message_id
  @message_id
end

- (boolean) success

true if the SMS is sent successfully, false otherwise.



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

def success
  @success
end