2020

USING QUARKXPRESS SERVER
serializeAs: Determines how the class is serialized. The valid values are: •
nameValue indicates that all members of the class should be handled as •
name-value pairs in the request to QuarkXPress Server. (This is the
default option in JPEGRenderRequest and
ModifierStreamRequest.)
xml indicates that the class should be serialized as XML with the class •
name or alias as the element value. All of the fields of the class are
serialized as child elements. If the field is a subclass of QRequest, it is
processed recursively. If the field is an array, it must be an array of
QRequest-derived classes.
mixed indicates that the class should be serialized as XML with the class •
name or alias as the element. All the primitive fields of the class are
serialized as attributes. If the field is a subclass of QRequest, it is
serialized as a child element and processed recursively. If the field is an
array, it must be an array of QRequest-derived classes.
attribute indicates that the class should be serialized as XML with the •
class name or alias as the element. The class must be primitive. All such
fields must be serialized as attributes of the element. Also, “value” fields
must be serialized as values of the element. Valid only if the parent class
has a serializeAs value of “xml” or “mixed.”
<Attribute>: One element for each class field. •
name: The name of the generated class variable. •
accessor: The name of the accessor that gets the property. If this value is •
null, the default accessor name is used. The default name is “get” +
CamelCase(name) (for example, if the name of the property is “quality,” the
default accessor method is getQuality).
mutator: The name of the accessor that sets the property. If this value is •
null, the default mutator name is used. The default name is “set” +
CamelCase(name) (for example, if the name of the property is “quality,” the
default mutator method is setQuality).
description: A description of the attribute. Unless this value is null, the •
description is included in variable headers and accessor and mutator headers
and is included in generated API docs.
type: The type of the class variable. If this value is null, the default type •
(string) is used. If this is not a primitive data type, it should be defined as a
separate Class element. If this attribute has a value of “reference,” it means
the class defined by name is a reference that will be used by a reference
attribute in the same Class element. Before serialization, the referring
values are set in this instance.
reference: Unless this attribute has a null value, during serialization the •
value of the field should be set in the reference class provided. Note that the
reference class should be declared using “type=reference” as explained
above.
readonly: If this value is true, this field is for read-only purposes and •
should be ignored during serialization.
A GUIDE TO QUARKXPRESS SERVER 2020 | 195