2017

Table Of Contents
USING QUARKXPRESS SERVER
A Guide to QuarkXPress Server 2017 | 199
Restart QuarkXPress Server Manager.
C
ompatible client side web-service stubs, for both Java and .NET can be found
at
[output location]/_client/stubs
Understanding ManagerSDK.xml
“ManagerSDK.xml” is used to generate client SDK classes for QuarkXPress Server
requests. Each element in “ManagerSDK.xml” corresponds to a request handler, a
r
ender type, or an element in the DTD.
A
client SDK class is generated for each element in the XML. Each property in the
DTD and each parameter of the request handler or render type also corresponds to a
unique element in the XML.
A Class variable is generated for each property, as follows.
<Class>: One element for each SDK class generated. The class generated is
derived from QRequest. Attributes are:
name: The name of the generated class.
namespace:
The namespace recognized by QuarkXPress Server when this
request class is translated into a QuarkXPress Server request.
description: A description of the class. Unless this value is null, the
description forms the header of the generated class and is included in the
generated API docs.
alias: The alias to be used as an element name if this request class is
serialized to XML. For example, when the Project class is serialized to
XML, the element used is
Project.
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.”