10.1

Table Of Contents
Timeout for the session in
milliseconds. If no call is executed
Long
timeout
in that time, session is expired and
all the open documents in that
session are closed without saving.
If 0 is passed as value of timeout,
default timeout is used. If a
negative value is passed as
timeout, the session never expires.
Closes all open documents in the session without saving them. If the
session does not exist, an error is returned. If an error occurs while closing
closeAlldocs
the document, it is logged and the document is marked closed in the
internal cache. No error is returned.
DescriptionTypeParameter
Session whose documents are to
be closed.
String
sessionId
Closes the specified document without saving it. If the session does not
exist, an error is returned. If the document is not open, and error is
closeDoc
returned. If the document is open in another session, an error is returned.
If an error occurs while closing the document, it is logged and the
document is marked closed in the internal cache. No error is returned.
DescriptionTypeParameter
Document to be closed.String
docName
Session in which document was
opened.
String
sessionId
Closes the specified session. If the session does not exist, an error is
returned. If any documents are still open in the session, an error is returned.
closeSession
DescriptionTypeParameter
Session to be closed.String
sessionId
Gets all the open documents in the session. If the session does not exist,
an error is returned.
getOpenDocs
DescriptionTypeParameter
Session whose open documents are
sought.
String
sessionId
Gets all open sessions.
getOpenSessions
Gets QuarkXPress Server preferences.
getPreferences
Sets QuarkXPress Server preferences.
setPreferences
Creates a DOM for the specified document.
getXPressDOM
Creates a new document for modification and keeps it open until further
notice. The document is created with a single layout. To create a more
newDoc
complex document, use the processRequestEx API. If a document with the
same name is already open, an error is returned. If the session does not
exist, an error is returned.
DescriptionTypeParameter
44 | A GUIDE TO QUARKXPRESS SERVER 10.1
USING QUARKXPRESS SERVER