Home · All Classes · All Namespaces · Modules · Functions · Files
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions

Tp::IncomingFileTransferChannel Class Reference

The IncomingFileTransferChannel class provides an object representing a Telepathy channel of type FileTransfer for incoming file transfers. More...

#include <TelepathyQt4/IncomingFileTransferChannel>

Inherits Tp::FileTransferChannel.

List of all members.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions


Detailed Description

The IncomingFileTransferChannel class provides an object representing a Telepathy channel of type FileTransfer for incoming file transfers.


Constructor & Destructor Documentation

Tp::IncomingFileTransferChannel::~IncomingFileTransferChannel ( ) [virtual]

Class destructor.

Tp::IncomingFileTransferChannel::IncomingFileTransferChannel ( const ConnectionPtr connection,
const QString &  objectPath,
const QVariantMap &  immutableProperties,
const Feature coreFeature = IncomingFileTransferChannel::FeatureCore 
) [protected]

Construct a new IncomingFileTransfer channel.

Parameters:
connectionConnection owning this channel, and specifying the service.
objectPathThe object path of this channel.
immutablePropertiesThe immutable properties of this channel.
coreFeatureThe core feature of the channel type, if any. The corresponding introspectable should depend on IncomingFileTransferChannel::FeatureCore.

Member Function Documentation

IncomingFileTransferChannelPtr Tp::IncomingFileTransferChannel::create ( const ConnectionPtr connection,
const QString &  objectPath,
const QVariantMap &  immutableProperties 
) [static]

Create a new InconmingFileTransferChannel object.

Parameters:
connectionConnection owning this channel, and specifying the service.
objectPathThe object path of this channel.
immutablePropertiesThe immutable properties of this channel.
Returns:
A StreamedMediaChannelPtr object pointing to the newly created StreamedMediaChannel object.

Reimplemented from Tp::FileTransferChannel.

PendingOperation * Tp::IncomingFileTransferChannel::acceptFile ( qulonglong  offset,
QIODevice *  output 
)

Accept a file transfer that's in the FileTransferStatePending state(). The state will change to FileTransferStateOpen as soon as the transfer starts. The given output device should not be closed/destroyed until the state() changes to FileTransferStateCompleted or FileTransferStateCancelled.

Only the primary handler of a file transfer channel may call this method.

This method requires FileTransferChannel::FeatureCore to be enabled.

Parameters:
offsetThe desired offset in bytes where the file transfer should start. The offset is taken from the beginning of the file. Specifying an offset of zero will start the transfer from the beginning of the file. The offset that is actually given in the initialOffset() method can differ from this argument where the requested offset is not supported. (For example, some protocols do not support offsets at all so the initialOffset() will always be 0.).
outputA QIODevice object where the data will be written to. The device should be ready to use when the state() changes to FileTransferStateCompleted. If the transfer is cancelled, state() becomes FileTransferStateCancelled, the data in output should be ignored
Returns:
A PendingOperation object which will emit PendingOperation::finished when the call has finished.
See also:
stateChanged(), state(), stateReason(), initialOffset()

Member Data Documentation

Feature representing the core that needs to become ready to make the IncomingFileTransferChannel object usable.

This is currently the same as FileTransferChannel::FeatureCore, but may change to include more.

When calling isReady(), becomeReady(), this feature is implicitly added to the requested features.

Reimplemented from Tp::FileTransferChannel.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.5.12