History

Wallet API JSDoc stubs

David Rowe committed 8 years ago

Commit 176dbb51 parent 46ebb041 file · +44 −0Browse files

Showing the changes to interface/src/scripting/WalletScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/WalletScriptingInterface.h+44−0
@@ -30,6 +30,14 @@ public: · 29 unmodified lines
3030 };
3131
3232
33+/**jsdoc
34+ * @namespace Wallet
35+ *
36+ * @hifi-interface
37+ * @hifi-client-entity
38+ *
39+ * @property {number} walletStatus
40+ */
3341 class WalletScriptingInterface : public QObject, public Dependency {
3442 Q_OBJECT
3543
@@ -38,17 +46,53 @@ class WalletScriptingInterface : public QObject, public Dependency { · 2 unmodified lines
3846 public:
3947 WalletScriptingInterface();
4048
49+ /**jsdoc
50+ * @function Wallet.refreshWalletStatus
51+ */
4152 Q_INVOKABLE void refreshWalletStatus();
53+
54+ /**jsdoc
55+ * @function Wallet.getWalletStatus
56+ * @returns {number}
57+ */
4258 Q_INVOKABLE uint getWalletStatus() { return _walletStatus; }
59+
60+ /**jsdoc
61+ * @function Wallet.proveAvatarEntityOwnershipVerification
62+ * @param {Uuid} entityID
63+ */
4364 Q_INVOKABLE void proveAvatarEntityOwnershipVerification(const QUuid& entityID);
65+
4466 // setWalletStatus() should never be made Q_INVOKABLE. If it were,
4567 // scripts could cause the Wallet to incorrectly report its status.
4668 void setWalletStatus(const uint& status);
4769
4870 signals:
71+
72+ /**jsdoc
73+ * @function Wallet.walletStatusChanged
74+ * @returns {Signal}
75+ */
4976 void walletStatusChanged();
77+
78+ /**jsdoc
79+ * @function Wallet.walletNotSetup
80+ * @returns {Signal}
81+ */
5082 void walletNotSetup();
83+
84+ /**jsdoc
85+ * @function Wallet.ownershipVerificationSuccess
86+ * @property {Uuid} entityID
87+ * @returns {Signal}
88+ */
5189 void ownershipVerificationSuccess(const QUuid& entityID);
90+
91+ /**jsdoc
92+ * @function Wallet.ownershipVerificationFailed
93+ * @property {Uuid} entityID
94+ * @returns {Signal}
95+ */
5296 void ownershipVerificationFailed(const QUuid& entityID);
5397
5498 private:

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t