A custom file transfer handler should return an instance of this class to tell PDG the outcome of the transfer operation
Methods ¶
Static methods ¶
cached()
→ pdg.TransferPair
Returns a TransferPair initialized with values that indicate that the file transfer was cached.
failure()
→ pdg.TransferPair
Returns a TransferPair initialized with values that indicate that the file transfer failed.
skip()
→ pdg.TransferPair
Returns a TransferPair initialized with values that indicate that the file transfer was skipped.
success(cache_id=0)
→ pdg.TransferPair
Returns a TransferPair initialized with values that indicate that the file transfer was successful, with an optional cache ID.
Instance Methods ¶
__init__(transfer_result, cache_id)
Constructs a new transfer pair from a pdg.transferResult and an integer cache ID.
cacheId
→ int
Property
The file transfer cache ID associated with this instance.
result
→ pdg.transferResult
Property
The file transfer result associated with this instance.