Grandstream Networks, Inc.
XML Application Guide
Page 12 of 24
Last Updated: 3/2009
XML
E
XPLANATION
R
OOT
E
LEMENT
“S
CREEN
”
The XML document has root element called
Screen
; it contains exactly 1 sub-element called
IdleScreen
.
In the future we can extend this syntax to allow customization of other screens (such as “RingingScreen”
and/or “InCallScreen” and eventually evolve to a “theme” concept.
<
xs:element
name
=
"
Screen
"
>
<
xs:complexType
>
<
xs:sequence
>
<
xs:element
name
=
"
IdleScreen
"
type
=
"
IdleScreenType
"
minOccurs
=
"
1
"
maxOccurs
=
"
1
"
/>
</
xs:sequence
>
</
xs:complexType
>
</
xs:element
>
E
LEMENT
“I
DLE
S
CREEN
T
YPE
”
This element defines three components that are makes up the idle screen. These components are defined
as elements which are described in 5.3-5.5.
<
xs:element
name
=
"
IdleScreen
"
minOccurs
=
"
1
"
maxOccurs
=
"
1
"
>
<
xs:complexType
>
<
xs:sequence
>
<!--
The ShowStatusLine element is now optional and default to false.
Ignored by GXP2020
-->
<
xs:element
name
=
"
ShowStatusLine
"
type
=
"
xs:boolean
"
minOccurs
=
"
0
"
maxOccurs
=
"
1
"
default
=
"
false
"
/>
<
xs:element
name
=
"
DisplayBitmap
"
type
=
"
BitmapType
"
minOccurs
=
"
0
"
maxOccurs
=
"
unbounded
"
nillable
=
"
true
"
/>
<
xs:element
name
=
"
DisplayString
"
type
=
"
StringType
"
minOccurs
=
"
0
"
maxOccurs
=
"
unbounded
"
nillable
=
"
true
"
/>
<!--
The DisplaySoftKey element apply only to GXP-2020/2010 and is ignored by GXP-2000
-->
<
xs:element
name
=
"
DisplaySoftKey
"
type
=
"
SoftKeyType
"
minOccurs
=
"
0
"
maxOccurs
=
"
12
"
nillable
=
"
true
"
/>
<!--
The UseDefaultSoftKeys element apply only to GXP-2020/2010 and is ignored by GXP-
2000. If it is missing by default it is false, when it is true, any DisplaySoftKey elements
would be ignored and the system default softkeys would apply
-->
<
xs:element
name
=
"
UseDefaultSoftKeys
"
type
=
"
xs:boolean
"
minOccurs
=
"
0
"
maxOccurs
=
"
1
"
default
=
"
false
"
/>
</
xs:sequence
>
</
xs:complexType
>
</
xs:element
>
Note: By the above grammar,
ShowStatusLine
is now optional and default to false (previously must appear
exactly once) and any number of
DisplayBitmap
,
DisplayString
and
DisplaySoftKey
instances.
D
ISPLAY
R
ULES
When
both DisplayBitmap
and
DisplayString
elements are present, all bitmaps will be rendered before
the strings are displayed. When multiple instances of the same type (bitmap/string) are present, they are
displayed in the order they appear in the XML and later objects (bitmap/string) may overwrite/corrupt
previous objects.
.