Snom Service Hub

Content

Page tree

The following attributes are supported in all the Snom Minibrowser main tags.


Index:


title

Description: Set the title for the main element. If both this and title tag written inside the main element exist, the value from this attribute will be taken as the title.

Valid Values: Any text

Don't use line break inside this attribute.

sort

Description: Sort a list. In order to use sorting in an SnomIPPhoneMenu it is also necessary to set the sort_key attribute

Valid values: true, false, yes, no, on, off.

You can see a sort usage example here


selectable

Description: Determine if list is selectable or not.

Valid values: true, false, yes, no, on, off.

You can see a selectable usage example here


predict

Description: Input with T9 (predictive text).

Valid values: true, false, yes, no, on, off.


dtmf

Description: If enabled DTMF tones are played on each digit input, otherwise no DTMF tones are played out.

Valid values: true, false, yes, no, on, off.


id

Description: An arbitrary id, that can be used to identify/select an element if it is contained in a batch of several main elements. See SnomIPPhoneBatch.

In a menu, the selected menu item defaults to name. If the name gets changed, the id can be used to keep the selection.

Valid Value: Any text identifying an element


document_id

Description: An arbitrary id, that can be used to prevent duplicates of the same Minibrowser XML file on reload

Valid Value: Any text identifying an element


track

Description: If false, the URL of the displayed XML document is not tracked in the history. That is, this document will be skipped when you go back in history by pressing the Cancel (X) button.

Valid values: true, false, yes, no, on, off.


state

Description:

  • If set to relevant, key events will not only be processed by the Minibrowser but also be forwarded to the underlying phone state
  • If set to only_mb, key events will only be processed by the Minibrowser (Default value).
  • If set to others_except_mb, unrecognized key events will not processed by Minibrowser.

Valid values: relevant, only_mb, others_except_mb.

You can see a state usage example here


show_line_info_layer

Description: If this is set to on, line info should be displayed. This attribute is no longer available in versions > 10.1.33.33, as the old Line Info Layer feature has been replaced by Smart Labels.

Valid values: on, off, smart


idle_timeout

Description: Automatically close the minibrowser after the specified amount of time if the user did not press any keys (available since version 10.1.82.0).

  • The time is given in seconds, 0 explicitly cancels the timer.
  • The timer is restarted after every key press.
  • The timer remains active in a given context after a new file has been  fetched, unless this file specified a new idle timeout.
  • The timer is not carried forward into a new MB context. A new context is created by setting the 'new_context' attribute of a URL subtag to true (see the MenuItem).

Valid values: An unsigned integer value


Examples

sort

XML code:

<?xml version="1.0" encoding="UTF-8"?>
<SnomIPPhoneMenu sort="yes">
	<MenuItem name="z line 1" sort_key="z line 1"></MenuItem>
	<MenuItem name="b line 2" sort_key="b line 2"></MenuItem>
	<MenuItem name="o line 3" sort_key="o line 3"></MenuItem>
	<MenuItem name="k line 4" sort_key="k line 4"></MenuItem>
</SnomIPPhoneMenu>


Result:

state

You can define 3 Minibrowser documents to state the different values for the state attribute:

relevant:

<?xml version="1.0" encoding="UTF-8"?>
<SnomIPPhoneText id="relevant" state="relevant">
	<Text>state = relevant </Text>
</SnomIPPhoneText>

only_mb:

<?xml version="1.0" encoding="UTF-8"?>
<SnomIPPhoneText id="only_mb" state="only_mb">
	<Text>state = only_mb </Text>
</SnomIPPhoneText>

others_except_mb:

<?xml version="1.0" encoding="UTF-8"?>
<SnomIPPhoneText id="others_except_mb" state="others_except_mb">
	<Text>state = others_except_mb </Text>
</SnomIPPhoneText>


To test this scenario you can setup 2 cases:

Case 1

  • Configure a function key as a speed dial to dial another extension
  • Activate this XML application
  • Press the speed dial after selecting a state


Results for Case 1:

  • only_mb : nothing happens
  • others_except_mb : speed dial is called
  • relevant : nothing happens

Case 2

  • Call the phone from another phone
  • On the called phone activate this XML application
  • Press the CANCEL key after selecting a state


Results for Case 2:

  • only_mb : minibrowser closes and phone goes back to connected screen
  • others_except_mb : minibrowser closes and phone goes back to connected screen
  • relevant : call disconnects and minibrowser closes

selectable

This example will result in a menu that cannot be selected:

<?xml version="1.0" encoding="UTF-8"?>
<SnomIPPhoneMenu selectable="off">
    <Menu name="m1">
        <MenuItem name="mi1"></MenuItem>
        <MenuItem name="mi2"></MenuItem>
        <MenuItem name="mi3"></MenuItem>
    </Menu>
    <Menu name="m2">
        <MenuItem name="mi1"></MenuItem>
        <MenuItem name="mi2"></MenuItem>
        <MenuItem name="mi3"></MenuItem>
    </Menu>
    <Menu name="m3">
        <MenuItem name="mi1"></MenuItem>
        <MenuItem name="mi2"></MenuItem>
        <MenuItem name="mi3"></MenuItem>
    </Menu>
    <Menu name="m4"></Menu>
    <Menu name="m5"></Menu>
    <Menu name="m6"></Menu>
    <Menu name="m7"></Menu>
</SnomIPPhoneMenu>


Further Information


Related articles