aastra_xml_api 1.0.0 → 1.0.1

data/lib/aastra_xml_api/AastraIPPhoneInputScreen.rb

@@ -1,249 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneInputScreen
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneInputScreen 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)
-#     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)
-#
-# Specific to the object - Single Input
-#     setURL(url) to set the URL to called after the input
-#     setType(type) to set type of input ('IP', 'string', 'number', 'dateUS'...), 'string' by default
-#     setDefault(default) to set default value for the input (optional)
-#     setParameter(param) to set the parameter name to be parsed after the input
-#     setInputLanguage(language) to set the language of the input (optional)
-#     setPassword to set the Password parameter to 'yes', 'no' by default (optional)
-#     setNotEditable to set the editable parameter to 'no', 'yes' by default (optional)
-#     setEditable is now replaced by setNotEditable but kept for compatibility reasons (optional)
-#     setPrompt(prompt) to set the prompt to be displayed for the input.
-#
-# Specific to the object - Multiple Inputs
-#     setURL(url) to set the URL to called after the input
-#     setType(type) to set the default type of input ('IP', 'string', 'number', 'dateUS'...), 'string' by default
-#     setDefault(default) to set default default value for the input (optional)
-#     setParameter(param) to set the default parameter name to be parsed after the input
-#     setPassword to set the default Password parameter to 'yes', 'no' by default (optional)
-#     setNotEditable to set the default editable parameter to 'no', 'yes' by default (optional)
-#     setEditable is now replaced by setNotEditable but kept for compatibility reasons (optional)
-#     setPrompt(prompt) to set the default prompt to be displayed for the input.
-#     setDefaultIndex(index) to define the field index the object will use to start (optional) default is 1
-#     setDisplayMode(display) to define the aspect of the display, normal/condensed (optional) default is normal.
-#     setInputLanguage(language) to set the language of the input (optional)
-#     addField(type) to add an input field and setting its type (IP, string, number, dateUS, timeUS,dateInt, timeInt or empty) if the type is an empty string then the type is inherited from the main object.
-#     setFieldPassword(password) to set the password mode for the input field ('yes', no'), overrides the value set by setPassword for the field
-#     setFieldEditable(editable) to set the input field editable mode ('yes', no'), overrides the value set by setEditable or setNotEditable for the field
-#     setFieldParameter(parameter) to set the parameter name to be parsed after the global input, overrides the value set by setParameter for the field
-#     setFieldPrompt(prompt)to set the prompt to be displayed for the input field, overrides the value set by setPrompt for the field
-#     setFieldSelection(selection) to set the Selection tag for the field
-#     setFieldDefault(default) to set default value for the input field, overrides the value set by setDefault for the field
-#     addFieldSoftkey(index,label,uri,icon) to add custom softkeys to the input field, overrides the softkeys set by addSoftkey.
-#
-# Example 1 - Single Input
-#     require 'AastraIPPhoneInputScreen.rb'
-#     input = AastraIPPhoneInputScreen.new
-#     input.setTitle('Title')
-#     input.setPrompt('Enter your password')
-#     input.setParameter('param')
-#     input.setType('string')
-#     input.setURL('http://myserver.com/script.php')
-#     input.setPassword
-#     input.setDestroyOnExit
-#     input.setDefault('Default')
-#     aastra_output input
-#
-# Example 2 - Multiple Inputs
-#     require 'AastraIPPhoneInputScreen.rb'
-#     input = AastraIPPhoneInputScreen.new
-#     input.setTitle('Example 2')
-#     input.setDisplayMode('condensed')
-#     input.setURL('http://myserver.com/script.php')
-#     input.setDestroyOnExit
-#     input.addSoftkey('5', 'Done', 'SoftKey:Submit')
-#     input.addField('string')
-#     input.setFieldPrompt('Username:')
-#     input.setFieldParameter('user')
-#     input.addFieldSoftkey('3', 'ABC', 'SoftKey:ChangeMode')
-#     input.addField('number')
-#     input.setFieldPassword('yes')
-#     input.setFieldPrompt('Pass:')
-#     input.setFieldParameter('passwd')
-#     aastra_output input
-#
-################################################################################
-
-class AastraIPPhoneInputScreen < AastraIPPhone
-  @url
-  @type
-  @parameter
-  @prompt
-  @editable
-  @default
-  @password
-  @defaultindex
-  @displaymode
-  @inputlanguage
-
-  # Set URL to be called (html post) when the input is submitted.
-  def setURL(url)
-    @url = url
-  end
-
-  # Sets the type of all fields (see addField for values) unless overriden
-  # by setFieldType.
-  def setType(type)
-    @type = type
-  end
-
-  # Sets all fields are editable. Kept only for compatibility.
-  def setEditable
-    @editable = "yes"
-  end
-
-  # Sets all fields as read only if not overriden by setFieldEditable.
-  def setNotEditable
-    @editable = "no"
-  end
-
-  # Set default value for all fields if not overriden by setFieldDefault.
-  def setDefault(default)
-    @default = default
-  end
-
-  # Set parameter name for all fields if not overriden by setFieldParameter.
-  def setParameter(parameter)
-    @parameter = parameter
-  end
-
-  # Set password input for all fields, masked by "*" characters if not
-  # overriden by setFieldPassword.
-  def setPassword
-    @password = "yes"
-  end
-
-  # Prompt for all input fields, if not overriden by setFieldPrompt.
-  def setPrompt(prompt)
-    @prompt = prompt
-  end
-
-  # Defines which field 1 (default) through 6 the user will start input on.
-  def setDefaultIndex(index)
-    @defaultindex = index
-  end
-
-  # Can be one of normal (default) or condensed.
-  def setDisplayMode(display)
-    @displaymode = display
-  end
-
-  # Defines the language character set used for input.
-  def setInputLanguage(input)
-    @inputlanguage = input
-  end
-
-  # Add a new field to get input for.  The type can be one of IP,
-  # string (default), number, timeUS, timeInt, dateUS, or dateInt.
-  def addField(type=nil)
-    @entries += [AastraIPPhoneInputScreenEntry.new(type)]
-  end
-
-  # Sets the type (see addField for values) of the most recently added
-  # field.
-  def setFieldType(type)
-    @entries[@entries.size-1].setType(type)
-  end
-
-  # Set the most recently added field as a password field and mask input
-  # by "*" characters.
-  def setFieldPassword
-    @entries[@entries.size-1].setPassword
-  end
-
-  # Set the most recently added field as editable.  This is the default.
-  def setFieldEditable
-    @entries[@entries.size-1].setEditable
-  end
-
-  # Set the most recently added field's parameter name in the form post
-  # when submitted.
-  def setFieldParameter(parameter)
-    @entries[@entries.size-1].setParameter(parameter)
-  end
-
-  # Set the most recently added field's prompt text.
-  def setFieldPrompt(prompt)
-    @entries[@entries.size-1].setPrompt(prompt)
-  end
-
-  # Set the most recently added field's default value.This is what is
-  # displayed when first shown.
-  def setFieldDefault(default)
-    @entries[@entries.size-1].setDefault(default)
-  end
-
-  # Sets the most recently added field's selection tag which is added
-  # to the request when the submit button is pressed while editing this
-  # field.
-  def setFieldSelection(selection)
-    @entries[@entries.size-1].setSelection(selection)
-  end
-
-  # Adds a softkey to be displayed when the most recently added field
-  # is highlighted.
-  def addFieldSoftkey(index, label, uri, icon=nil)
-    @entries[@entries.size-1].addSoftkey(index, label, uri, icon)
-  end
-
-  # Create XML text output.
-  def render
-    @type = 'string' if @type.nil?
-    xml = "<AastraIPPhoneInputScreen type=\"#{@type}\""
-    xml += " password=\"yes\"" if @password == "yes"
-    xml += " destroyOnExit=\"yes\"" if @destroyOnExit == "yes"
-    xml += " cancelAction=\"#{escape(@cancelAction)}\"" if not @cancelAction.nil?
-    xml += " editable=\"no\"" if @editable == "no"
-    xml += " Beep=\"yes\"" if @beep == "yes"
-    xml += " defaultIndex=\"#{@defaultindex}\"" if not @defaultindex.nil?
-    xml += " inputLanguage=\"#{@inputlanguage}\"" if not @inputlanguage.nil?
-    xml += " displayMode=\"#{@displaymode}\"" if not @displaymode.nil?
-    xml += " LockIn=\"yes\"" if @lockin == "yes"
-    xml += " allowAnswer=\"yes\"" if @allowAnswer == "yes"
-    xml += " Timeout=\"#{@timeout}\"" if @timeout != 0
-    xml += ">\n"
-    if not @title.nil? then
-      xml += "<Title"
-      out += " wrap=\"yes\"" if @title_wrap == "yes"
-      xml += ">#{escape(@title)}</Title>\n"
-    end
-    xml += "<Prompt>#{escape(@prompt)}</Prompt>\n" if not @prompt.nil?
-    xml += "<URL>#{escape(@url)}</URL>\n"
-    xml += "<Parameter>#{@parameter}</Parameter>\n" if not @parameter.nil?
-    xml += "<Default>#{@default}</Default>\n"
-    @entries.each { |entry| xml += entry.render }
-    @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 += "</AastraIPPhoneInputScreen>\n"
-    return xml
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneInputScreenEntry.rb

@@ -1,84 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneInputScreenEntry
-# Firmware 2.2.0 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneInputScreen object.
-################################################################################
-
-class AastraIPPhoneInputScreenEntry
-  @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 += [AastraIPPhoneSoftkeyEntry.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

data/lib/aastra_xml_api/AastraIPPhoneSoftkeyEntry.rb

@@ -1,37 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneSoftkeyEntry
-# Firmware 2.2.0 or better
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhone object.
-################################################################################
-
-class AastraIPPhoneSoftkeyEntry
-  @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

data/lib/aastra_xml_api/AastraIPPhoneStatus.rb

@@ -1,66 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneStatus
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# AastraIPPhoneStatus object.
-#
-# Public methods
-#
-# Inherited from AastraIPPhone
-#     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 'AastraIPPhoneStatus.rb'
-#     status = AastraIPPhoneStatus.new
-#     status.setSession('Session');
-#     status.setBeep
-#     status.addEntry('1', 'Message 1', '', 0)
-#     status.addEntry('2', 'Message 2', 'alert', 5)
-#     aastra_output status
-#
-################################################################################
-
-class AastraIPPhoneStatus < AastraIPPhone
-  @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 += [AastraIPPhoneStatusEntry.new(index, message, type, timeout)]
-  end
-
-  # Create XML text output.
-  def render
-    xml = "<AastraIPPhoneStatus"
-    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 += "</AastraIPPhoneStatus>\n"
-    return xml
-  end
-  end

data/lib/aastra_xml_api/AastraIPPhoneStatusEntry.rb

@@ -1,56 +0,0 @@
-################################################################################
-# Aastra XML API Classes - AastraIPPhoneStatusEntry
-# Copyright Aastra Telecom 2008
-#
-# Ruby adaptation by Carlton O'Riley
-#
-# Internal class for AastraIPPhoneStatus object.
-################################################################################
-
-class AastraIPPhoneStatusEntry < AastraIPPhone
-  @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