Class: ReturnStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-agi/rs/exec.rb,
lib/ruby-agi/command.rb,
lib/ruby-agi/rs/noop.rb,
lib/ruby-agi/rs/answer.rb,
lib/ruby-agi/rs/hangup.rb,
lib/ruby-agi/rs/verbose.rb,
lib/ruby-agi/rs/say_time.rb,
lib/ruby-agi/rs/tdd_mode.rb,
lib/ruby-agi/rs/send_text.rb,
lib/ruby-agi/rs/set_music.rb,
lib/ruby-agi/rs/say_digits.rb,
lib/ruby-agi/rs/say_number.rb,
lib/ruby-agi/rs/send_image.rb,
lib/ruby-agi/rs/record_file.rb,
lib/ruby-agi/rs/set_context.rb,
lib/ruby-agi/rs/stream_file.rb,
lib/ruby-agi/rs/get_variable.rb,
lib/ruby-agi/rs/receive_char.rb,
lib/ruby-agi/rs/receive_text.rb,
lib/ruby-agi/rs/say_phonetic.rb,
lib/ruby-agi/rs/set_priority.rb,
lib/ruby-agi/rs/set_variable.rb,
lib/ruby-agi/rs/return_status.rb,
lib/ruby-agi/rs/set_caller_id.rb,
lib/ruby-agi/rs/set_extension.rb,
lib/ruby-agi/rs/channel_status.rb,
lib/ruby-agi/rs/wait_for_digit.rb,
lib/ruby-agi/rs/set_auto_hangup.rb,
lib/ruby-agi/rs/wait_for_digits.rb

Overview

class to handle return status from Command#wait_for_digits pressing ‘#’ will always terminate the input process

Command Reference: GET DATA <file to be streamed> [timeout] [max digits]

failure: 200 result=-1 timeout: 200 result=<digits> (timeout) success: 200 result=<digits> <digits> is the digits pressed.

Instance Method Summary collapse

Constructor Details

#initialize(command, message) ⇒ ReturnStatus

Returns a new instance of ReturnStatus.



30
31
32
33
 
# File 'lib/ruby-agi/rs/return_status.rb', line 30

def initialize(command, message)
	@command	= command.to_s.strip
	@message	= message.to_s.strip
end

Instance Method Details

#command ⇒ Object 



36
37
38
 
# File 'lib/ruby-agi/rs/return_status.rb', line 36

def command
	return @command
end

#command_error? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/ruby-agi/rs/return_status.rb', line 83

def command_error?
	if @is_command_error.nil?
		if (result.empty? or (not (return_code == '200')))
			@is_command_error = true
		else
			@is_command_error = false
		end
	end

	return @is_command_error
end

#message ⇒ Object 



41
42
43
 
# File 'lib/ruby-agi/rs/return_status.rb', line 41

def message
	return @message
end

#result ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/ruby-agi/rs/return_status.rb', line 56

def result
	if @result.nil?
		str = message.split(' ')
		@result = str[1].split('=')[1].to_s.strip
	end

	return @result
end

#return_code ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/ruby-agi/rs/return_status.rb', line 46

def return_code
	if @return_code.nil?
		str = message.split(' ')
		@return_code = str[0].to_s.strip
	end
	
	return @return_code
end

#to_s ⇒ Object 



78
79
80
 
# File 'lib/ruby-agi/rs/return_status.rb', line 78

def to_s
	return command + ' >> ' + message
end