aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/phone_input_screen_entry.rb

@@ -0,0 +1,86 @@
+################################################################################
+# Aastra XML API Classes - PhoneInputScreenEntry
+# Firmware 2.2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for PhoneInputScreen object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneInputScreenEntry
+    @type
+    @password
+    @editable
+    @parameter
+    @prompt
+    @default
+    @selection
+    @softkeys
+
+    # Create new input field as a given type. The type can be one of IP,
+    # string (default), number, timeUS, timeInt, dateUS, or dateInt.
+    def initialize(type)
+      @type = type
+      @softkeys = []
+    end
+
+    # Set the type (see initialize for values) of this input field.
+    def setType(type)
+      @type = type
+    end
+
+    # Set this input field as a password field masked by "*" characters.
+    def setPassword
+      @password = "yes"
+    end
+
+    # Make this input field editable, i.e. not read only.
+    def setEditable
+      @editable = "yes"
+    end
+
+    # Set paramter name value to be used to identify this field on submit.
+    def setParameter(parameter)
+      @parameter = parameter
+    end
+
+    # Set prompt to be displayed to let user know what this field is for.
+    def setPrompt(prompt)
+      @prompt = prompt
+    end
+
+    # Set default value to load this field with.
+    def setDefault(default)
+      @default = default
+    end
+
+    # The contents of this will be added when the submit key is pressed while
+    # editing this field.
+    def setSelection(selection)
+      @selection = selection
+    end
+
+    # Adds softkey to be displayed when editing this field.
+    def addSoftkey(index, label, uri, icon=nil)
+      @softkeys += [PhoneSoftkeyEntry.new(index, label, uri, icon)]
+    end
+
+    # Create XML text output for this entry.
+    def render
+      xml = "<InputField"
+      xml += " type=\"#{@type}\"" if not @type.nil?
+      xml += " password=\"yes\"" if @password == "yes"
+      xml += " editable=\"yes\"" if @editable == "yes"
+      xml += ">\n"
+      xml += "<Prompt>#{@prompt}</Prompt>\n" if not @prompt.nil?
+      xml += "<Parameter>#{@parameter}</Parameter>\n" if not @parameter.nil?
+      xml += "<Selection>#{@selection}</Selection>\n" if not @selection.nil?
+      xml += "<Default>#{@default}</Default>\n" if not @default.nil?
+      @softkeys.each { |softkey| xml += softkey.render }
+      xml += "</InputField>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/phone_softkey_entry.rb

@@ -0,0 +1,39 @@
+################################################################################
+# Aastra XML API Classes - PhoneSoftkeyEntry
+# Firmware 2.2.0 or better
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for Phone object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneSoftkeyEntry
+    @index
+    @label
+    @uri
+    @icon
+
+    # Create new softkey entry at index showing on screen with label. When
+    # pressed will call URI. Next to the label text the given icon
+    # will be shown.
+    def initialize(index, label, uri, icon)
+      @index = index
+      @label = label
+      @uri = uri
+      @icon = icon
+    end
+
+    # Create XML text output for this entry.
+    def render
+      xml = "<SoftKey index=\"#{@index}\""
+      xml += " icon=\"#{@icon}\"" if not @icon.nil?
+      xml += ">\n"
+      xml += "<Label>#{@label}</Label>\n"
+      xml += "<URI>#{@uri}</URI>\n"
+      xml += "</SoftKey>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/phone_status.rb

@@ -0,0 +1,68 @@
+################################################################################
+# Aastra XML API Classes - PhoneStatus
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# PhoneStatus object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     setBeep to enable a notification beep with the object (optional)
+#
+# Specific to the object
+#     setSession(session) to setup the session ID
+#     setTriggerDestroyOnExit to set the triggerDestroyOnExit tag to
+#     "yes" (optional)
+#     addEntry(index,message,type,timeout) to add a message to be displayed
+#     on the idle screen.
+#
+# Example
+#     require 'PhoneStatus.rb'
+#     status = PhoneStatus.new
+#     status.setSession('Session');
+#     status.setBeep
+#     status.addEntry('1', 'Message 1', '', 0)
+#     status.addEntry('2', 'Message 2', 'alert', 5)
+#     aastra_output status
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneStatus < Phone
+    @session
+    @triggerDestroyOnExit
+
+    # Sets the session associated with this status message.  Only important
+    # if more than one application is sending status messages.
+    def setSession(session)
+      @session = session
+    end
+
+    # When set, the previous user interface XML object is destroyed
+    # if its destroyOnExit tag is also set to yes.
+    def setTriggerDestroyOnExit
+      @triggerDestroyOnExit = "yes"
+    end
+
+    # Adds a new status message to be displayed at index. The type can only
+    # be nothing (default) or alert which shows the message for 3 seconds.
+    # The timeout can override the default 3 seconds for an alert message.
+    def addEntry(index, message, type=nil, timeout=nil)
+      @entries += [PhoneStatusEntry.new(index, message, type, timeout)]
+    end
+
+    # Create XML text output.
+    def render
+      xml = "<PhoneStatus"
+      xml += " Beep=\"yes\"" if @beep == "yes"
+      xml += " triggerDestroyOnExit=\"yes\"" if @triggerDestroyOnExit == "yes"
+      xml += ">\n"
+      xml += "<Session>#{@session}</Session>\n"
+      @entries.each { |entry| xml += entry.render }
+      xml += "</PhoneStatus>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/phone_status_entry.rb

@@ -0,0 +1,58 @@
+################################################################################
+# Aastra XML API Classes - PhoneStatusEntry
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for PhoneStatus object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneStatusEntry < Phone
+    @index
+    @message
+    @type
+    @timeout
+
+    # 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.
+    def initialize(index, message, type=nil, timeout=nil)
+      @index = index
+      @message = message
+      setType(type)
+      @timeout = timeout
+    end
+
+    # Set the index of this message.
+    def setIndex(index)
+      @index = index
+    end
+
+    # Set the text of the message.
+    def setMessage(message)
+      @message = message
+    end
+
+    # Set the type of the message. Either "alert" or normal (blank and default)
+    def setType(type)
+      @type = type if type.nil?
+      @type = "alert" if not type.nil?
+    end
+
+    # Set the timeout (in seconds) of an alert message
+    def setTimeout(timeout)
+      @timeout = timeout
+    end
+
+    # Create XML text output of this entry
+    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
+  end
+end

data/lib/aastra_xml_api/phone_text_menu.rb

@@ -0,0 +1,148 @@
+################################################################################
+# Aastra XML API Classes - PhoneTextMenu
+# Copyright Aastra Telecom 2008
+#
+# PhoneTextMenu object.
+#
+# Public methods
+#
+# Inherited from Phone
+#     setTitle(Title) to setup the title of an object (optional)
+#     setTitleWrap to set the title to be wrapped on 2 lines (optional)
+#     setDestroyOnExit to set DestroyOnExit parameter to "yes" (optional)
+#     setCancelAction(uri) to set the cancel parameter with the URI to be called on Cancel (optional)
+#     setBeep to enable a notification beep with the object (optional)
+#     setLockIn to set the Lock-in tag to 'yes' (optional)
+#     setAllowAnswer to set the allowAnswer tag to 'yes' (optional)
+#     setTimeout(timeout) to define a specific timeout for the XML object (optional)
+#     addSoftkey(index,label,uri,icon_index) to add custom softkeys to the object (optional)
+#     addIcon(index,icon) to add custom icons to the object (optional)
+#     setRefresh(timeout,URL) to add Refresh parameters to the object (optional)
+#
+# Specific to the object
+#     setDefaultIndex(index) to set the default selection in the list (optional)
+#     setStyle(style) to set the style of the list numbered/none/radio (optional)
+#     setWrapList to allow 2 lines items (optional)
+#     addEntry(name,url,selection,icon,dial) to add an element in the list to be displayed
+#     natsortbyname to order the list
+#
+# Example 1
+#    require 'PhoneTextMenu.rb'
+#    menu = PhoneTextMenu.new
+#    menu.setTitle('Title')
+#    menu.setDestroyOnExit
+#    menu.setDeFaultIndex('3')
+#    menu.addEntry('Choice 2', 'http://myserver.com/script.php?choice=2', 'Value=2')
+#    menu.addEntry('Choice 1', 'http://myserver.com/script.php?choice=1', 'Value=1')
+#    menu.addEntry('Choice 3', 'http://myserver.com/script.php?choice=3', 'Value=3')
+#    menu.natsortByName
+#    menu.addSoftkey('1', 'My Select', 'http://myserver.com/script.php?action=1')
+#    menu.addSoftkey('6', 'Exit', 'SoftKey:Exit')
+#    aastra_output menu
+#
+# Example 2
+#    require 'PhoneTextMenu.rb'
+#    menu = PhoneTextMenu.new
+#    menu.setTitle('Title')
+#    menu.setDestroyOnExit
+#    menu.setDeFaultIndex('2')
+#    menu.addEntry('Choice 2', 'http://myserver.com/script.php?choice=2', 'Value=2','1')
+#    menu.addEntry('Choice 1', 'http://myserver.com/script.php?choice=1', 'Value=1','2')
+#    menu.addEntry('Choice 3', 'http://myserver.com/script.php?choice=3', 'Value=3','3')
+#    menu.natsortByName
+#    menu.addSoftkey('1', 'My Select', 'http://myserver.com/script.php?action=1')
+#    menu.addSoftkey('6', 'Exit', 'SoftKey:Exit')
+#    menu.addIcon('1', 'Icon:PhoneOnHook')
+#    menu.addIcon('2', 'Icon:PhoneOffHook')
+#    menu.addIcon('3', 'Icon:PhoneRinging')
+#    aastra_output menu
+#
+################################################################################
+
+module AastraXmlApi
+  class PhoneTextMenu < Phone
+    @defaultIndex
+    @style
+    @wraplist
+    @maxitems
+
+    # Sets the default index to highlight when first shown.
+    def setDefaultIndex(defaultIndex)
+      @defaultIndex = defaultIndex
+    end
+
+    # Set the style to one of numbered (default), none, or radio.
+    def setStyle(style)
+      @style = style
+    end
+
+    # Add a menu entry with name displayed and calls url when selected.  The
+    # selection option is the value appended to a custom softkey URL when
+    # this item is highlighted. icon is a reference to an included icon
+    # that is shown with the menu entry.  dial is what is called when
+    # the user hits a softkey with the URI "SoftKey:Dial2".
+    def addEntry(name, url, selection=nil, icon=nil, dial=nil)
+      @entries += [PhoneTextMenuEntry.new(name, url, selection, icon, dial)]
+    end
+
+    # Allows entries in the list to wrap.
+    def setWrapList
+      @wraplist = "yes"
+    end
+
+    # Use natural order sorting to sort the menu by name.
+    def natsortByName
+      tmparray = []
+      tmp_array.include(ArrayExtension)
+      linklist = {}
+      for i in 0..@entries.size-1
+        tmparray += [@entries[i].getName]
+        linklist[@entries[i].getName] = i
+      end
+      tmparray.natsort!
+      newentries = []
+      tmparray.each do |name|
+        newentries += [@entries[linklist[name]]]
+      end
+      @entries = newentries
+    end
+
+    # Create XML text output.
+    def render
+      @maxitems = 30 if @maxitems.nil?
+      xml = "<PhoneTextMenu"
+      xml += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
+      xml += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
+      xml += " defaultIndex=\"#{@defaultIndex}\"" if not @defaultIndex.nil?
+      xml += " style=\"#{@style}\"" if not @style.nil?
+      xml += " Beep=\"yes\"" if @beep == "yes"
+      xml += " LockIn=\"yes\"" if @lockin == "yes"
+      xml += " wrapList=\"yes\"" if @wraplist == "yes"
+      xml += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
+      xml += " Timeout=\"#{@timeout}\"" if @timeout != 0
+      xml += ">\n"
+      if not @title.nil? then
+        xml += "<Title"
+        xml += " wrap=\"yes\"" if @title_wrap == "yes"
+        xml += ">#{escape(@title)}</Title>\n"
+      end
+      index = 0
+      @entries.each do |entry|
+        xml += entry.render if index < @maxitems
+        index += 1
+      end
+      @softkeys.each { |softkey| xml += softkey.render }
+      iconList = 0
+      @icons.each do |icon|
+        if iconList == 0 then
+          xml += "<IconList>\n"
+          iconList = 1
+        end
+        xml += icon.render
+      end
+      xml += "</IconList>\n" if iconList != 0
+      xml += "</PhoneTextMenu>\n"
+      return xml
+    end
+  end
+end

data/lib/aastra_xml_api/phone_text_menu_entry.rb

@@ -0,0 +1,54 @@
+################################################################################
+# Aastra XML API Classes - PhoneTextMenuEntry
+# Copyright Aastra Telecom 2008
+#
+# Ruby adaptation by Carlton O'Riley
+#
+# Internal class for PhoneTextMenu object.
+################################################################################
+
+module AastraXmlApi
+  class PhoneTextMenuEntry < Phone
+    @name
+    @url
+    @selection
+    @icon
+    @dial
+
+    # Create new text menu entry with given name to be displayed, url to be
+    # called when selected. Selection is the value appended to a custom URI
+    # attached to a softkey.  This will be added as either ?selection=value
+    # or &selection=value depending on if the URI already has parameters.
+    # icon is the index of the icon to be displayed to the left of the
+    # given entry.  dial is the number to call if the user pushes a softkey
+    # with URI SoftKey:Dial2.
+    def initialize(name, url, selection, icon, dial)
+      @name = name
+      @url = url
+      @selection = selection
+      @icon = icon
+      @dial = dial
+      @selection = nil if @selection == ''
+      @icon = nil if @icon == ''
+      @dial = nil if @dial == ''
+    end
+
+    # Returns the name associated with this entry.
+    def getName
+      return @name
+    end
+
+    # Create XML text output of this entry.
+    def render
+      xml = "<MenuItem"
+      xml += " icon=\"#{@icon}\"" if not @icon.nil?
+      xml += ">\n"
+      xml += "<Prompt>#{escape(@name)}</Prompt>\n"
+      xml += "<URI>#{escape(@url)}</URI>\n"
+      xml += "<Selection>#{escape(@selection)}</Selection>\n" if not @selection.nil?
+      xml += "<Dial>#{@dial}</Dial>\n" if not @dial.nil?
+      xml += "</MenuItem>\n"
+      return xml
+    end
+  end
+end