C H A P T E R 2 2
Transport Interface
About Transports
22-3
destAppSymbol
Optional. A symbol identifying the application to receive the
item, if it is different from the sending application.
Applications that send data should set this slot to identify the
receiving application, if it is different from the sending one.
On the receiving side, the transport method
item, if it is different from the sending application.
Applications that send data should set this slot to identify the
receiving application, if it is different from the sending one.
On the receiving side, the transport method
NewFromItem
copies this value into the
appSymbol
slot of the received
item frame.
body
The frame being sent (or references to the data). This is
supplied by the application. This can be a multiple-item
target object that references more than one data object to
send. All application-specific data should be stored within the
supplied by the application. This can be a multiple-item
target object that references more than one data object to
send. All application-specific data should be stored within the
body
slot.
title
Optional. This string is used in the In/Out Box as the item's
title. The transport may provide this for received items that
do not contain a data definition. If this slot is not provided,
the transport obtains a title from the item's data definition.
title. The transport may provide this for received items that
do not contain a data definition. If this slot is not provided,
the transport obtains a title from the item's data definition.
remote
A value interpreted as a Boolean. Any non-
nil
value
indicates an item whose body is stored remotely. The
transport must set this slot if it downloads just the title of an
item but leaves the body stored remotely. When the user tries
to view the item, the In Box alerts the transport to download
the body of the item from the remote host by sending it the
transport must set this slot if it downloads just the title of an
item but leaves the body stored remotely. When the user tries
to view the item, the In Box alerts the transport to download
the body of the item from the remote host by sending it the
ReceiveRequest
message.
connect
A Boolean used for items to be sent. This slot is set to
true
if the user chooses to send the item immediately with the
Send button in the routing slip. If the user chooses to send the
item later, this slot is set to
Send button in the routing slip. If the user chooses to send the
item later, this slot is set to
nil
. Note that this slot can also
be set by the format method
SetupItem
or the
Send
function.
error
An integer error code; non-
nil
indicates an error. This is
usually set by
ItemCompleted
.
currentFormat
A symbol identifying the selected format for this item.
hidden
A Boolean; if
true
, the item is not displayed in the In/Out
Box. If set to true, the
completionScript
slot must also
be set to
true
and the application must have an
ItemCompletionScript
method.
covert
A Boolean; if
true
, the item is not logged or saved.
state
A symbol indicating status:
'ready
,
'sent
,
'received
,
'read
,
'inLog
,
'outLog
, or
'pending
. This is usually
set by
ItemCompleted
. Do not set this
slot directly.