aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/AastraIPPhoneConfigurationEntry.rb

@@ -1,41 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneConfigurationEntry
-# Firmware 2.0 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneConfiguration object.
-################################################################################
-class AastraIPPhoneConfigurationEntry < AastraIPPhone
-  @parameter
-  @value
-
-  # Create a new parameter/value pair.  This overrides the
-  # initialize method in AastraIPPhone.
-  def initialize(parameter, value)
-    @parameter = parameter
-    @value = value
-  end
-
-  # Set the parameter for this entry.
-  def setParameter(parameter)
-    @parameter = parameter
-  end
-
-  # Set the value for this entry.
-  def setValue(value)
-    @value = value
-  end
-
-  # Create XML text output for this entry.
-  def render
-    parameter = escape(@parameter)
-    value = escape(@value)
-    xml = "<ConfigurationItem>\n"
-    xml += "<Parameter>#{parameter}</Parameter>\n"
-    xml += "<Value>#{value}</Value>\n"
-    xml += "</ConfigurationItem>\n"
-    return xml
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneDirectory.rb

@@ -1,119 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneDirectory
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneDirectory object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     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', 'no' by default (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)
-#     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
-#     setNext(next) to set URI of the next page (optional)
-#     setPrevious(previous) to set URI of the previous page (optional)
-#     addEntry(name,phone) to add an element in the list to be displayed, at least one is needed.
-#     natsortbyname to order the list
-#
-# Example
-#     require 'AastraIPPhoneDirectory.rb'
-#     directory = AastraIPPhoneDirectory.new
-#     directory.setTitle('Title')
-#     directory.setNext('http://myserver.com/script.php?page=2')
-#     directory.setPrevious('http://myserver.com/script.php?page=0')
-#     directory.setDestroyOnExit
-#     directory.addEntry('John Doe', '200')
-#     directory.addEntry('Jane Doe', '201')
-#     directory.natsortByName
-#     directory.addSoftkey('1', 'Label', 'http://myserver.com/script.php?action=1')
-#     directory.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#     aastra_output directory
-#
-################################################################################
-
-class AastraIPPhoneDirectory < AastraIPPhone
-  @next
-  @previous
-
-  # Set the URI to load the next page of the directory.
-  def setNext(nextval)
-    @next = nextval
-  end
-
-  # Set the URI to load the previous page of the directory.
-  def setPrevious(previous)
-    @previous = previous
-  end
-
-  # Add directory entry with a name to be displayed and a telephone
-  # number to dial.
-  def addEntry(name, telephone)
-    @entries += [AastraIPPhoneDirectoryEntry.new(name, telephone)]
-  end
-
-  # Sort array of names using natural sort order. i.e. Bob2 comes
-  # before Bob10.
-  def natsortByName
-    tmparray = []
-    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
-    out = "<AastraIPPhoneDirectory"
-    if not @previous.nil? then
-      previous = escape(@previous)
-      out += " previous=\"#{previous}\""
-    end
-    if not @next.nil? then
-      nextval = escape(@next)
-      out += " next=\"#{nextval}\""
-    end
-    out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    if not @cancelAction.nil? then
-      cancelAction = escape(@cancelAction)
-      out += " cancelAction=\"#{cancelAction}\""
-    end
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " LockIn=\"yes\"" if @lockin == "yes"
-    out += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    out += ">\n"
-    if not @title.nil? then
-      title = escape(title)
-      out += "<Title"
-      out += " wrap=\"yes\"" if @title_wrap == "yes"
-      out += ">#{title}</Title>\n"
-    end
-    index = 0
-    @entries.each do |entry|
-      out += entry.render if index < 30
-      index += 1
-    end
-    @softkeys.each do |softkey|
-      out += softkey.render
-    end
-    out += "</AastraIPPhoneDirectory>\n"
-    return out
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneDirectoryEntry.rb

@@ -1,32 +0,0 @@
-########################################################################################################
-# Aastra XML API Classes - AastraIPPhoneDirectoryEntry
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneDirectory object.
-########################################################################################################
-
-class AastraIPPhoneDirectoryEntry < AastraIPPhone
-  @name
-  @telephone
-
-  # Create new name and number entry.  Overrides the initialize method
-  # of AastraIPPhone.
-  def initialize(name, telephone)
-    @name = name
-    @telephone = telephone
-  end
-
-  # Get the name associated with this entry.
-  def getName
-    @name
-  end
-
-  # Create XML text output for this entry.
-  def render
-    name = escape(@name)
-    telephone = escape(@telephone)
-    return "<MenuItem>\n<Prompt>#{name}</Prompt>\n<URI>#{telephone}</URI>\n</MenuItem>\n"
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneExecute.rb

@@ -1,58 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneExecute
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneExecute object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setBeep to enable a notification beep with the object (optional)
-#
-# Specific to the object
-#     setTriggerDestroyOnExit to set the triggerDestroyOnExit tag to "yes" (optional)
-#     addEntry(url,interruptCall) to add an action to be executed.
-#
-# Example
-#     require 'AastraIPPhoneExecute.class.php'
-#     execute = AastraIPPhoneExecute.new
-#     execute.addEntry('http://myserver.com/script.php?choice=2')
-#     execute.addEntry('Command: Reset')
-#     aastra_output execute
-#
-################################################################################
-
-class AastraIPPhoneExecute < AastraIPPhone
-  @defaultIndex
-  @triggerDestroyOnExit
-
-  # Add a url (action to be performed).  If interruptCall is not nil, then
-  # then if a dial action is given, the current call will be put on hold.
-  # Default behavior is to not allow a current active call to be
-  # interrupted.
-  def addEntry(url, interruptCall=nil)
-    @entries += [AastraIPPhoneExecuteEntry.new(url, interruptCall)]
-  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
-
-  # Create XML text output.
-  def render
-    title = escape(@title)
-    out = "<AastraIPPhoneExecute"
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " triggerDestroyOnExit=\"yes\"" if @triggerDestroyOnExit == "yes"
-    out += ">\n"
-    @entries.each do |entry|
-      out += entry.render
-    end
-    out += "</AastraIPPhoneExecute>\n"
-    return out
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneExecuteEntry.rb

@@ -1,30 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneExecuteEntry
-# Firmware 1.4.1 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneExecute object.
-################################################################################
-
-class AastraIPPhoneExecuteEntry < AastraIPPhone
-  @url
-  @interruptCall
-
-  # Create a new action to be performed.  if interruptCall is not nil then
-  # a currently active call can be interrupted by this action.
-  def initialize(url, interruptCall)
-    @url = url
-    @interruptCall = interruptCall
-  end
-
-  # Create XML text output for this entry.
-  def render
-    url = escape(@url)
-    xml = "<ExecuteItem URI=\"#{url}\""
-    xml += " interruptCall=\"no\"" if @interruptCall == "no"
-    xml += "/>\n"
-    return xml
-  end
-end

data/lib/aastra_xml_api/AastraIPPhoneFormattedTextScreen.rb

@@ -1,117 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPFormattedPhoneTextScreen
-# Copyright Aastra Telecom 2008
-#
-# AastraIPPhoneFormattedTextScreen object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     setDestroyOnExit to set DestroyonExit parameter to 'yes', 'no' by default (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) 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
-#     addLine(text,size,align) to add a formatted line
-#     setScrollStart(height) to define the beginning of the scrolling section and its height
-#     setScrollEnd to define the end of the scrolling section
-#     setAllowDTMF to allow DTMF passthrough on the object
-#     setDoneAction(uri) to set the URI to be called when the user selects the default "Done" key (optional)
-#
-# Example
-#     require 'AastraIPPhoneFormattedTextScreen.rb'
-#     ftext = AastraIPPhoneFormattedTextScreen.new
-#     ftext.setDestroyOnExit
-#     ftext.addLine('Formatted Screen', 'double', 'center')
-#     ftext.setScrollStart('2')
-#     ftext.addLine('Scrolled text1')
-#     ftext.addLine('Scrolled text2')
-#     ftext.addLine('Scrolled text3')
-#     ftext.addLine('Scrolled text4')
-#     ftext.addLine('Scrolled text5')
-#     ftext.setScrollEnd
-#     ftext.addLine('Footer',NULL,'center')
-#     ftext.addSoftkey('1', 'Label', 'http://myserver.com/script.php?action=1','1')
-#     ftext.addSoftkey('6', 'Exit', 'SoftKey:Exit')
-#     ftext.addIcon('1', 'Icon:Envelope')
-#     aastra_output ftext
-#
-################################################################################
-
-class AastraIPPhoneFormattedTextScreen < AastraIPPhone
-  @doneAction
-  @allowDTMF
-
-  # Add a line of formatted text. size can only be 'normal' (default)
-  # or 'double'. align can be one of 'left' (default), 'center',
-  # or 'right'.
-  def addLine(text, size=nil, align=nil)
-    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(text, size, align, 'normal')]
-  end
-
-  # Starts the beginning of a scrolling section on the display. If height
-  # is not given, then all available space is used to display the scrolling
-  # section. Otherwise, height cannot be bigger than 2.
-  def setScrollStart(height=nil)
-    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(nil, height, nil, 'scrollstart')]
-  end
-
-  # Sets the end of a scrolling section on the display.
-  def setScrollEnd
-    @entries += [AastraIPPhoneFormattedTextScreenEntry.new(nil, nil, nil, 'scrollend')]
-  end
-
-  # Defines URI to call when the user selects the 'Done' softkey.
-  def setDoneAction(uri)
-    @doneAction = uri
-  end
-
-  # Allows keypad strokes to generate DTMF when a call is in progress
-  # while this object is displayed.
-  def setAllowDTMF
-    @allowDTMF = "yes"
-  end
-
-  # Create XML text output.
-  def render
-    out = "<AastraIPPhoneFormattedTextScreen"
-    out += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    if not @cancelAction.nil? then
-      cancelAction = escape(@cancelAction)
-      out += " cancelAction=\"#{cancelAction}\""
-    end
-    if not @doneAction.nil? then
-      doneAction = escape(@doneAction)
-      out += " doneAction=\"#{doneAction}\""
-    end
-    out += " Beep=\"yes\"" if @beep == "yes"
-    out += " LockIn=\"yes\"" if @lockin == "yes"
-    out += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
-    out += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    out += " allowDTMF=\"#{yes}\"" if @allowDTMF == "yes"
-    out += ">\n"
-    @entries.each do |entry|
-      out += entry.render
-    end
-    @softkeys.each do |softkey|
-      out += softkey.render
-    end
-    iconList = 0
-    @icons.each do |icon|
-      if iconList == 0 then
-        out += "<IconList>\n"
-        iconList = 1
-      end
-      out += icon.render
-    end
-    out += "</IconList>\n" if iconList != 0
-    out += "</AastraIPPhoneFormattedTextScreen>\n"
-    return out
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneFormattedTextScreenEntry.rb

@@ -1,48 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneFormattedTextScreenEntry
-# Firmware 2.0 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneFormattedTextScreen object.
-################################################################################
-
-class AastraIPPhoneFormattedTextScreenEntry < AastraIPPhone
-  @text
-  @size
-  @align
-  @type
-
-  # Creates new formatted text entry.  size is one of 'normal' (default)
-  # or 'double'. align is one of 'left' (default), 'center', or 'right'.
-  # type must be one of 'normal', 'scrollstart', or 'scrollend'.
-  def initialize(text, size, align, type)
-    if size == 'double' then
-      @text = convert_high_ascii(text)
-    else
-      @text = text
-    end
-    @size = size
-    @align = align
-    @type = type
-  end
-
-  # Create XML text output for this entry.
-  def render
-    case @type
-    when "normal"
-      xml = "<Line"
-      xml += " Size=\"#{@size}\"" if not @size.nil?
-      xml += " Align=\"#{@align}\"" if not @align.nil?
-      xml += ">"
-      xml += "#{escape(@text)}</Line>\n"
-    when "scrollstart"
-      xml = "<Scroll"
-      xml += " Height=\"#{@size}\"" if not @size.nil?
-      xml += ">\n"
-    when "scrollend" then xml = "</Scroll>\n"
-    end
-    return xml
-  end
-end