KItinerary::File
KItinerary::File Class Reference
#include <file.h>
Public Types | |
enum | OpenMode { Read, Write } |
Public Member Functions | |
File (const File &)=delete | |
File (const QString &fileName) | |
File (File &&) | |
File (QIODevice *device) | |
void | addCustomData (const QString &scope, const QString &id, const QByteArray &data) |
void | addDocument (const QString &id, const QVariant &docInfo, const QByteArray &docData) |
void | addPass (const QString &passId, const QByteArray &rawData) |
void | addPass (KPkPass::Pass *pass, const QByteArray &rawData) |
void | addReservation (const QString &id, const QVariant &res) |
void | addReservation (const QVariant &res) |
void | close () |
QByteArray | customData (const QString &scope, const QString &id) const |
QByteArray | documentData (const QString &id) const |
QVariant | documentInfo (const QString &id) const |
QList< QString > | documents () const |
QString | errorString () const |
QList< QString > | listCustomData (const QString &scope) const |
bool | open (OpenMode mode) const |
File & | operator= (const File &)=delete |
File & | operator= (File &&) |
QByteArray | passData (const QString &passId) const |
QList< QString > | passes () const |
QVariant | reservation (const QString &resId) const |
QList< QString > | reservations () const |
void | setFileName (const QString &fileName) |
Static Public Member Functions | |
static QString | normalizeDocumentFileName (const QString &1) |
static QString | passId (const KPkPass::Pass *pass) |
static QString | passId (const QString &passTypeIdenfier, const QString &serialNumber) |
Detailed Description
A file containing a bundle of reservations and associated documents.
This is used to export or transfer a set of reservation-related documents while keeping the associations between them.
A KItinerary::File can contain the following elements:
- JSON-LD reservation objects (see KItinerary::Reservation). Each reservation has a UUID.
- PkPass files. Their identifier is determined by their pass type identifier and their serial number.
- JSON-LD document objects (see KItinerary::CreativeWork) and their associated file content. Each document has a UUID.
- Application-specific data in custom namespaces.
Constructor & Destructor Documentation
◆ File() [1/2]
|
explicit |
◆ File() [2/2]
|
explicit |
Member Function Documentation
◆ addCustomData()
void File::addCustomData | ( | const QString & | scope, |
const QString & | id, | ||
const QByteArray & | data | ||
) |
◆ addDocument()
void File::addDocument | ( | const QString & | id, |
const QVariant & | docInfo, | ||
const QByteArray & | docData | ||
) |
◆ addPass() [1/2]
void File::addPass | ( | const QString & | passId, |
const QByteArray & | rawData | ||
) |
◆ addPass() [2/2]
void File::addPass | ( | KPkPass::Pass * | pass, |
const QByteArray & | rawData | ||
) |
◆ addReservation() [1/2]
◆ addReservation() [2/2]
void File::addReservation | ( | const QVariant & | res | ) |
◆ close()
void File::close | ( | ) |
◆ customData()
QByteArray File::customData | ( | const QString & | scope, |
const QString & | id | ||
) | const |
◆ documentData()
QByteArray File::documentData | ( | const QString & | id | ) | const |
◆ documentInfo()
◆ documents()
◆ errorString()
QString File::errorString | ( | ) | const |
◆ listCustomData()
◆ normalizeDocumentFileName()
◆ open()
bool File::open | ( | File::OpenMode | mode | ) | const |
◆ passData()
QByteArray File::passData | ( | const QString & | passId | ) | const |
◆ passes()
◆ passId()
|
static |
◆ reservation()
◆ reservations()
◆ setFileName()
void File::setFileName | ( | const QString & | fileName | ) |
The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Thu Sep 28 2023 04:00:17 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Thu Sep 28 2023 04:00:17 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.