Class SchemaListDescriptor
Object
|
+--SchemaDescriptor
|
+--SchemaListDescriptor
- class
SchemaListDescriptor
- extends SchemaDescriptor
A schema descriptor that specifies a schema through a list of field
names. A descriptor of this type requires that the default Metadata Adapter
(i.e. the LiteralBasedProvider) or a compatible one is used on the Server. This
ensures that the encoded field name list is correctly interpreted on the
Server side.
Note that directly passing an Array object is supported,
as a shorthand for a SchemaListDescriptor,
by all interface methods that require a SchemaDescriptor object.
See:
Defined in lspushpage.js
Constructor Summary |
SchemaListDescriptor
(<Array> fieldNames)
Creates a schema descriptor object that specifies a schema through a list
of field names.
|
Method Summary |
Array
|
getList()
Inquiry method that gets the list of field names specified by this schema
descriptor.
|
SchemaListDescriptor
SchemaListDescriptor(<Array> fieldNames)
Creates a schema descriptor object that specifies a schema through a list
of field names.
Parameters:
fieldNames
- an array of String field names. Array elements should be stored by starting at index 1. However, Javascript arrays implicitly start with a 0 index. For example, if fieldNames is defined by the literal ['a', 'b', 'c'], then 'a' is defined as fieldNames[0]. Using such an array is also allowed, but the 'a' field is still associated with position 1. Hence, if a field position is used as a field descriptor for field 'a', then it should specify position 1.
Only alphanumeric names are supported (underscore, caret and dot characters are also allowed); moreover, using numbers as field names is not allowed.
getList
Array getList()
Inquiry method that gets the list of field names specified by this schema
descriptor.
Returns:
An array of String field names. The names are always reported starting from index 1.
Lightstreamer HTML Client API
Documentation generated by
JSDoc on Tue May 22 11:46:54 2012