Snapshot API JSDoc stubs

This commit is contained in:
David Rowe 2018-05-12 16:32:33 +12:00
parent b445371ad8
commit 74617822fa

View file

@ -34,6 +34,14 @@ private:
QUrl _URL;
};
/**jsdoc
* @namespace Snapshot
*
* @hifi-interface
* @hifi-client-entity
*/
class Snapshot : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
@ -46,11 +54,28 @@ public:
static void uploadSnapshot(const QString& filename, const QUrl& href = QUrl(""));
signals:
/**jsdoc
* @function Snapshot.snapshotLocationSet
* @param {string} location
* @returns {Signal}
*/
void snapshotLocationSet(const QString& value);
public slots:
/**jsdoc
* @function Snapshot.getSnapshotsLocation
* @returns {string}
*/
Q_INVOKABLE QString getSnapshotsLocation();
/**jsdoc
* @function Snapshot.setSnapshotsLocation
* @param {String} location
*/
Q_INVOKABLE void setSnapshotsLocation(const QString& location);
private:
static QFile* savedFileForSnapshot(QImage& image,
bool isTemporary,