class PureCloud::FaxStatus
Attributes
active_page[RW]
Active page of the transmission.
baud_rate[RW]
Current signaling rate of transmission, baud rate.
bytes_transmitted[RW]
Number
of bytes that have competed transmission.
direction[RW]
The fax direction, either "send" or "receive".
expected_pages[RW]
Total number of expected pages, if known.
line_errors[RW]
Number
of line errors.
lines_transmitted[RW]
Number
of lines that have completed transmission.
page_errors[RW]
Number
of page errors.
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/fax_status.rb, line 46 def self.attribute_map { :'direction' => :'direction', :'expected_pages' => :'expectedPages', :'active_page' => :'activePage', :'lines_transmitted' => :'linesTransmitted', :'bytes_transmitted' => :'bytesTransmitted', :'baud_rate' => :'baudRate', :'page_errors' => :'pageErrors', :'line_errors' => :'lineErrors' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/fax_status.rb, line 83 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'direction'] self.direction = attributes[:'direction'] end if attributes[:'expectedPages'] self.expected_pages = attributes[:'expectedPages'] end if attributes[:'activePage'] self.active_page = attributes[:'activePage'] end if attributes[:'linesTransmitted'] self.lines_transmitted = attributes[:'linesTransmitted'] end if attributes[:'bytesTransmitted'] self.bytes_transmitted = attributes[:'bytesTransmitted'] end if attributes[:'baudRate'] self.baud_rate = attributes[:'baudRate'] end if attributes[:'pageErrors'] self.page_errors = attributes[:'pageErrors'] end if attributes[:'lineErrors'] self.line_errors = attributes[:'lineErrors'] end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/fax_status.rb, line 69 def self.swagger_types { :'direction' => :'String', :'expected_pages' => :'Integer', :'active_page' => :'Integer', :'lines_transmitted' => :'Integer', :'bytes_transmitted' => :'Integer', :'baud_rate' => :'Integer', :'page_errors' => :'Integer', :'line_errors' => :'Integer' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/fax_status.rb, line 125 def ==(o) return true if self.equal?(o) self.class == o.class && direction == o.direction && expected_pages == o.expected_pages && active_page == o.active_page && lines_transmitted == o.lines_transmitted && bytes_transmitted == o.bytes_transmitted && baud_rate == o.baud_rate && page_errors == o.page_errors && line_errors == o.line_errors end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/fax_status.rb, line 168 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /^(true|t|yes|y|1)$/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
_to_hash(value)
click to toggle source
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloud/models/fax_status.rb, line 228 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
build_from_hash(attributes)
click to toggle source
build the object from hash
# File lib/purecloud/models/fax_status.rb, line 149 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
eql?(o)
click to toggle source
@see the `==` method
# File lib/purecloud/models/fax_status.rb, line 139 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/fax_status.rb, line 144 def hash [direction, expected_pages, active_page, lines_transmitted, bytes_transmitted, baud_rate, page_errors, line_errors].hash end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/fax_status.rb, line 216 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
to_s()
click to toggle source
# File lib/purecloud/models/fax_status.rb, line 206 def to_s to_hash.to_s end