class AastraXmlApi::PhoneStatusEntry

Public Class Methods

new(index, message, type=nil, timeout=nil) click to toggle source

Create new status message at index. Type can only be “alert” or left blank. If the type is anything but blank, it is automatically set to “alert”. The timeout overrides the default 3 seconds for an alert message.

# File lib/aastra_xml_api/phone_status_entry.rb, line 21
def initialize(index, message, type=nil, timeout=nil)
  @index = index
  @message = message
  setType(type)
  @timeout = timeout
end

Public Instance Methods

render() click to toggle source

Create XML text output of this entry

# File lib/aastra_xml_api/phone_status_entry.rb, line 50
def render
  xml = "<Message index=\"#{escape(@index)}\""
  xml += " type=\"#{escape(@type)}\"" if not @type.nil?
  xml += " Timeout=\"#{@timeout}\"" if not @timeout.nil?
  xml += ">#{escape(@message)}</Message>\n"
  return xml
end
setIndex(index) click to toggle source

Set the index of this message.

# File lib/aastra_xml_api/phone_status_entry.rb, line 29
def setIndex(index)
  @index = index
end
setMessage(message) click to toggle source

Set the text of the message.

# File lib/aastra_xml_api/phone_status_entry.rb, line 34
def setMessage(message)
  @message = message
end
setTimeout(timeout) click to toggle source

Set the timeout (in seconds) of an alert message

# File lib/aastra_xml_api/phone_status_entry.rb, line 45
def setTimeout(timeout)
  @timeout = timeout
end
setType(type) click to toggle source

Set the type of the message. Either “alert” or normal (blank and default)

# File lib/aastra_xml_api/phone_status_entry.rb, line 39
def setType(type)
  @type = type if type.nil?
  @type = "alert" if not type.nil?
end