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
30};30};
31 31
32 32
33/**jsdoc
34 * @namespace Wallet
35 *
36 * @hifi-interface
37 * @hifi-client-entity
38 *
39 * @property {number} walletStatus
40 */
33class WalletScriptingInterface : public QObject, public Dependency {41class WalletScriptingInterface : public QObject, public Dependency {
34 Q_OBJECT42 Q_OBJECT
35 43
@@ -38,17 +46,53 @@ class WalletScriptingInterface : public QObject, public Dependency { · 2 unmodified lines
38public:46public:
39 WalletScriptingInterface();47 WalletScriptingInterface();
40 48
49 /**jsdoc
50 * @function Wallet.refreshWalletStatus
51 */
41 Q_INVOKABLE void refreshWalletStatus();52 Q_INVOKABLE void refreshWalletStatus();
53
54 /**jsdoc
55 * @function Wallet.getWalletStatus
56 * @returns {number}
57 */
42 Q_INVOKABLE uint getWalletStatus() { return _walletStatus; }58 Q_INVOKABLE uint getWalletStatus() { return _walletStatus; }
59
60 /**jsdoc
61 * @function Wallet.proveAvatarEntityOwnershipVerification
62 * @param {Uuid} entityID
63 */
43 Q_INVOKABLE void proveAvatarEntityOwnershipVerification(const QUuid& entityID);64 Q_INVOKABLE void proveAvatarEntityOwnershipVerification(const QUuid& entityID);
65
44 // setWalletStatus() should never be made Q_INVOKABLE. If it were,66 // setWalletStatus() should never be made Q_INVOKABLE. If it were,
45 // scripts could cause the Wallet to incorrectly report its status.67 // scripts could cause the Wallet to incorrectly report its status.
46 void setWalletStatus(const uint& status);68 void setWalletStatus(const uint& status);
47 69
48signals:70signals:
71
72 /**jsdoc
73 * @function Wallet.walletStatusChanged
74 * @returns {Signal}
75 */
49 void walletStatusChanged();76 void walletStatusChanged();
77
78 /**jsdoc
79 * @function Wallet.walletNotSetup
80 * @returns {Signal}
81 */
50 void walletNotSetup();82 void walletNotSetup();
83
84 /**jsdoc
85 * @function Wallet.ownershipVerificationSuccess
86 * @property {Uuid} entityID
87 * @returns {Signal}
88 */
51 void ownershipVerificationSuccess(const QUuid& entityID);89 void ownershipVerificationSuccess(const QUuid& entityID);
90
91 /**jsdoc
92 * @function Wallet.ownershipVerificationFailed
93 * @property {Uuid} entityID
94 * @returns {Signal}
95 */
52 void ownershipVerificationFailed(const QUuid& entityID);96 void ownershipVerificationFailed(const QUuid& entityID);
53 97
54private:98private:

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