class AastraXmlApi::PhoneInputScreen
Public Instance Methods
Add a new field to get input for. The type can be one of IP, string (default), number, timeUS, timeInt, dateUS, or dateInt.
# File lib/aastra_xml_api/phone_input_screen.rb, line 160 def addField(type=nil) @entries += [PhoneInputScreenEntry.new(type)] end
Adds a softkey to be displayed when the most recently added field is highlighted.
# File lib/aastra_xml_api/phone_input_screen.rb, line 207 def addFieldSoftkey(index, label, uri, icon=nil) @entries[@entries.size-1].addSoftkey(index, label, uri, icon) end
Create XML text output.
# File lib/aastra_xml_api/phone_input_screen.rb, line 212 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
Set default value for all fields if not overriden by setFieldDefault.
# File lib/aastra_xml_api/phone_input_screen.rb, line 123 def setDefault(default) @default = default end
Defines which field 1 (default) through 6 the user will start input on.
# File lib/aastra_xml_api/phone_input_screen.rb, line 144 def setDefaultIndex(index) @defaultindex = index end
Can be one of normal (default) or condensed.
# File lib/aastra_xml_api/phone_input_screen.rb, line 149 def setDisplayMode(display) @displaymode = display end
Sets all fields are editable. Kept only for compatibility.
# File lib/aastra_xml_api/phone_input_screen.rb, line 113 def setEditable @editable = "yes" end
Set the most recently added field’s default value.This is what is displayed when first shown.
# File lib/aastra_xml_api/phone_input_screen.rb, line 194 def setFieldDefault(default) @entries[@entries.size-1].setDefault(default) end
Set the most recently added field as editable. This is the default.
# File lib/aastra_xml_api/phone_input_screen.rb, line 177 def setFieldEditable @entries[@entries.size-1].setEditable end
Set the most recently added field’s parameter name in the form post when submitted.
# File lib/aastra_xml_api/phone_input_screen.rb, line 183 def setFieldParameter(parameter) @entries[@entries.size-1].setParameter(parameter) end
Set the most recently added field as a password field and mask input by “*” characters.
# File lib/aastra_xml_api/phone_input_screen.rb, line 172 def setFieldPassword @entries[@entries.size-1].setPassword end
Set the most recently added field’s prompt text.
# File lib/aastra_xml_api/phone_input_screen.rb, line 188 def setFieldPrompt(prompt) @entries[@entries.size-1].setPrompt(prompt) 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.
# File lib/aastra_xml_api/phone_input_screen.rb, line 201 def setFieldSelection(selection) @entries[@entries.size-1].setSelection(selection) end
Sets the type (see addField for values) of the most recently added field.
# File lib/aastra_xml_api/phone_input_screen.rb, line 166 def setFieldType(type) @entries[@entries.size-1].setType(type) end
Defines the language character set used for input.
# File lib/aastra_xml_api/phone_input_screen.rb, line 154 def setInputLanguage(input) @inputlanguage = input end
Sets all fields as read only if not overriden by setFieldEditable.
# File lib/aastra_xml_api/phone_input_screen.rb, line 118 def setNotEditable @editable = "no" end
Set parameter name for all fields if not overriden by setFieldParameter.
# File lib/aastra_xml_api/phone_input_screen.rb, line 128 def setParameter(parameter) @parameter = parameter end
Set password input for all fields, masked by “*” characters if not overriden by setFieldPassword.
# File lib/aastra_xml_api/phone_input_screen.rb, line 134 def setPassword @password = "yes" end
Prompt for all input fields, if not overriden by setFieldPrompt.
# File lib/aastra_xml_api/phone_input_screen.rb, line 139 def setPrompt(prompt) @prompt = prompt end
Sets the type of all fields (see addField for values) unless overriden by setFieldType.
# File lib/aastra_xml_api/phone_input_screen.rb, line 108 def setType(type) @type = type end
Set URL to be called (html post) when the input is submitted.
# File lib/aastra_xml_api/phone_input_screen.rb, line 102 def setURL(url) @url = url end