class Bandwidth::CallState
CallState
Model.
Attributes
TODO: Write general description for this method @return [String]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [DateTime]
TODO: Write general description for this method @return [String]
TODO: Write general description for this method @return [String]
TODO: Write general description for this method @return [String]
The reason the call was disconnected, or null if the call is still active. Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup', 'invalid-bxml', 'callback-error', 'application-error', 'error', 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes may be added in the future, so your application must be tolerant of unknown values. @return [String]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [DateTime]
The reason the call was disconnected, or null if the call is still active. Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup', 'invalid-bxml', 'callback-error', 'application-error', 'error', 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes may be added in the future, so your application must be tolerant of unknown values. @return [String]
The reason the call was disconnected, or null if the call is still active. Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup', 'invalid-bxml', 'callback-error', 'application-error', 'error', 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes may be added in the future, so your application must be tolerant of unknown values. @return [String]
TODO: Write general description for this method @return [String]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [String]
The reason the call was disconnected, or null if the call is still active. Current values are 'cancel', 'timeout', 'busy', 'rejected', 'hangup', 'invalid-bxml', 'callback-error', 'application-error', 'error', 'account-limit', 'node-capacity-exceeded' and 'unknown'. Additional causes may be added in the future, so your application must be tolerant of unknown values. @return [DateTime]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [Hash]
TODO: Write general description for this method @return [String]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [DateTime]
The current state of the call. Current possible values are 'initiated', 'answered' and 'disconnected'. Additional states may be added in the future, so your application must be tolerant of unknown values. @return [String]
TODO: Write general description for this method @return [String]
Public Class Methods
Creates an instance of the object from a hash.
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 170 def self.from_hash(hash) return nil unless hash # Extract variables from the hash. call_id = hash['callId'] parent_call_id = hash['parentCallId'] application_id = hash['applicationId'] account_id = hash['accountId'] to = hash['to'] from = hash['from'] direction = hash['direction'] state = hash['state'] identity = hash['identity'] pai = hash['pai'] start_time = DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'] answer_time = DateTimeHelper.from_rfc3339(hash['answerTime']) if hash['answerTime'] end_time = DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'] disconnect_cause = hash['disconnectCause'] error_message = hash['errorMessage'] error_id = hash['errorId'] last_update = DateTimeHelper.from_rfc3339(hash['lastUpdate']) if hash['lastUpdate'] # Create object from extracted values. CallState.new(call_id, parent_call_id, application_id, account_id, to, from, direction, state, identity, pai, start_time, answer_time, end_time, disconnect_cause, error_message, error_id, last_update) end
A mapping from model property names to API property names.
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 111 def self.names @_hash = {} if @_hash.nil? @_hash['call_id'] = 'callId' @_hash['parent_call_id'] = 'parentCallId' @_hash['application_id'] = 'applicationId' @_hash['account_id'] = 'accountId' @_hash['to'] = 'to' @_hash['from'] = 'from' @_hash['direction'] = 'direction' @_hash['state'] = 'state' @_hash['identity'] = 'identity' @_hash['pai'] = 'pai' @_hash['start_time'] = 'startTime' @_hash['answer_time'] = 'answerTime' @_hash['end_time'] = 'endTime' @_hash['disconnect_cause'] = 'disconnectCause' @_hash['error_message'] = 'errorMessage' @_hash['error_id'] = 'errorId' @_hash['last_update'] = 'lastUpdate' @_hash end
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 133 def initialize(call_id = nil, parent_call_id = nil, application_id = nil, account_id = nil, to = nil, from = nil, direction = nil, state = nil, identity = nil, pai = nil, start_time = nil, answer_time = nil, end_time = nil, disconnect_cause = nil, error_message = nil, error_id = nil, last_update = nil) @call_id = call_id @parent_call_id = parent_call_id @application_id = application_id @account_id = account_id @to = to @from = from @direction = direction @state = state @identity = identity @pai = pai @start_time = start_time @answer_time = answer_time @end_time = end_time @disconnect_cause = disconnect_cause @error_message = error_message @error_id = error_id @last_update = last_update end
Public Instance Methods
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 220 def to_answer_time DateTimeHelper.to_rfc3339(answer_time) end
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 224 def to_end_time DateTimeHelper.to_rfc3339(end_time) end
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 228 def to_last_update DateTimeHelper.to_rfc3339(last_update) end
# File lib/bandwidth/voice_lib/voice/models/call_state.rb, line 216 def to_start_time DateTimeHelper.to_rfc3339(start_time) end