Home · All Classes · All Namespaces · Modules · Functions · Files |
The FileTransferChannelCreationProperties class represents the properties of a file transfer channel request. More...
#include <TelepathyQt/FileTransferChannelCreationProperties>
The FileTransferChannelCreationProperties class represents the properties of a file transfer channel request.
Create an invalid FileTransferChannelCreationProperties.
Tp::FileTransferChannelCreationProperties::FileTransferChannelCreationProperties | ( | const QString & | suggestedFileName, |
const QString & | contentType, | ||
qulonglong | size | ||
) |
Create a FileTransferChannelCreationProperties.
If suggestedFileName or contentType are empty or if size is equal to zero, the channel request will fail. suggestedFileName will be cleaned of any path.
suggestedFileName | The name of the file on the sender's side. This is therefore given as a suggested filename for the receiver. |
contentType | The content type (MIME) of the file. |
size | The size of the content of the file. |
Tp::FileTransferChannelCreationProperties::FileTransferChannelCreationProperties | ( | const QString & | path, |
const QString & | contentType | ||
) |
Create a FileTransferChannelCreationProperties.
This constructor accepts the path to a local file and sets the properties that can be deducted from the file. If path is not a local file the FileTransferChannelCreationProperties will be invalid.
path | The path to the local file to be sent. |
Tp::FileTransferChannelCreationProperties::FileTransferChannelCreationProperties | ( | const FileTransferChannelCreationProperties & | other | ) |
Copy constructor.
Class destructor.
bool Tp::FileTransferChannelCreationProperties::isValid | ( | ) | const [inline] |
FileTransferChannelCreationProperties & Tp::FileTransferChannelCreationProperties::operator= | ( | const FileTransferChannelCreationProperties & | other | ) |
bool Tp::FileTransferChannelCreationProperties::operator== | ( | const FileTransferChannelCreationProperties & | other | ) | const |
FileTransferChannelCreationProperties & Tp::FileTransferChannelCreationProperties::setContentHash | ( | FileHashType | contentHashType, |
const QString & | contentHash | ||
) |
Set the content hash of the file and its type for the request.
contentHashType | The type of content hash. |
contentHash | The hash of the file, of type contentHashType. |
FileTransferChannelCreationProperties & Tp::FileTransferChannelCreationProperties::setDescription | ( | const QString & | description | ) |
Set a description of the file for the request.
description | The description of the file. |
FileTransferChannelCreationProperties & Tp::FileTransferChannelCreationProperties::setLastModificationTime | ( | const QDateTime & | lastModificationTime | ) |
Set the last modification time of the file for the request.
lastModificationTime | The last modification time of the file. |
FileTransferChannelCreationProperties & Tp::FileTransferChannelCreationProperties::setUri | ( | const QString & | uri | ) |
Set the URI of the file for the request.
uri | The URI of the file. |
QString Tp::FileTransferChannelCreationProperties::suggestedFileName | ( | ) | const |
Return the suggested file name for the request. If the suggested file name is empty, the channel request will fail.
QString Tp::FileTransferChannelCreationProperties::contentType | ( | ) | const |
Return the content type (MIME) of the file for the request. If the content type is empty, the channel request will fail.
qulonglong Tp::FileTransferChannelCreationProperties::size | ( | ) | const |
Return the size of the contents of the file for the request. If size is zero, the channel request will fail.
bool Tp::FileTransferChannelCreationProperties::hasContentHash | ( | ) | const |
Return whether the request will have a content hash.
true
whether it will have a content hash, false
otherwise. Return the type of the content hash for the request.
QString Tp::FileTransferChannelCreationProperties::contentHash | ( | ) | const |
Return the content hash of the file for the request.
bool Tp::FileTransferChannelCreationProperties::hasDescription | ( | ) | const |
Return whether the request will have a descriprion.
true
whether it will have description, false
otherwise. QString Tp::FileTransferChannelCreationProperties::description | ( | ) | const |
Return the description of the file for the request.
Return whether the request will have a last modification time.
true
whether it will have a last modification time, false
otherwise. QDateTime Tp::FileTransferChannelCreationProperties::lastModificationTime | ( | ) | const |
Return the last modification time of the file for the request.
bool Tp::FileTransferChannelCreationProperties::hasUri | ( | ) | const |
QString Tp::FileTransferChannelCreationProperties::uri | ( | ) | const |
Return the URI of the file for the request. If the URI property is empty and the file transfer is handled by an handler that is not this process, then it won't be able to initiate the file transfer.
Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation | Telepathy-Qt 0.9.3 |