Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-04-23 13:33:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Account and GlobalServices JSDoc

Browse source
This commit is contained in:
David Rowe 2019-12-07 19:37:43 +13:00
parent c0dbec7940
commit fbc62df5d8
1 changed files with 81 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
interface/src/scripting/AccountServicesScriptingInterface.h
View file

@ -46,6 +46,7 @@ class AccountServicesScriptingInterface : public QObject {
* @hifi-avatar
*
* @namespace AccountServices
*
* @property {string} username - The user name of the user logged in. If there is no user logged in, it is
* <code>"Unknown user"</code>. <em>Read-only.</em>
* @property {boolean} loggedIn - <code>true</code> if the user is logged in, otherwise <code>false</code>.
@ -61,6 +62,86 @@ class AccountServicesScriptingInterface : public QObject {
* &mdash; typically <code>"https://metaverse.highfidelity.com"</code>. <em>Read-only.</em>
*/
/**jsdoc
* The <code>Account</code> API provides functions that give information on user connectivity, visibility, and asset
* download progress.
*
* @deprecated This API is the same as the {@link AccountServices} API and will be removed.
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @namespace Account
*
* @property {string} username - The user name of the user logged in. If there is no user logged in, it is
* <code>"Unknown user"</code>. <em>Read-only.</em>
* @property {boolean} loggedIn - <code>true</code> if the user is logged in, otherwise <code>false</code>.
* <em>Read-only.</em>
* @property {string} findableBy - The user's visibility to other users:
* <ul>
* <li><code>"none"</code> &mdash; user appears offline.</li>
* <li><code>"friends"</code> &mdash; user is visible only to friends.</li>
* <li><code>"connections"</code> &mdash; user is visible to friends and connections.</li>
* <li><code>"all"</code> &mdash; user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in
* &mdash; typically <code>"https://metaverse.highfidelity.com"</code>. <em>Read-only.</em>
*
* @borrows AccountServices.getDownloadInfo as getDownloadInfo
* @borrows AccountServices.updateDownloadInfo as updateDownloadInfo
* @borrows AccountServices.isLoggedIn as isLoggedIn
* @borrows AccountServices.checkAndSignalForAccessToken as checkAndSignalForAccessToken
* @borrows AccountServices.logOut as logOut
*
* @borrows AccountServices.connected as connected
* @borrows AccountServices.disconnected as disconnected
* @borrows AccountServices.myUsernameChanged as myUsernameChanged
* @borrows AccountServices.downloadInfoChanged as downloadInfoChanged
* @borrows AccountServices.findableByChanged as findableByChanged
* @borrows AccountServices.loggedInChanged as loggedInChanged
*/
/**jsdoc
* The <code>GlobalServices</code> API provides functions that give information on user connectivity, visibility, and asset
* download progress.
*
* @deprecated This API is the same as the {@link AccountServices} API and will be removed.
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @namespace GlobalServices
*
* @property {string} username - The user name of the user logged in. If there is no user logged in, it is
* <code>"Unknown user"</code>. <em>Read-only.</em>
* @property {boolean} loggedIn - <code>true</code> if the user is logged in, otherwise <code>false</code>.
* <em>Read-only.</em>
* @property {string} findableBy - The user's visibility to other users:
* <ul>
* <li><code>"none"</code> &mdash; user appears offline.</li>
* <li><code>"friends"</code> &mdash; user is visible only to friends.</li>
* <li><code>"connections"</code> &mdash; user is visible to friends and connections.</li>
* <li><code>"all"</code> &mdash; user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in
* &mdash; typically <code>"https://metaverse.highfidelity.com"</code>. <em>Read-only.</em>
*
* @borrows AccountServices.getDownloadInfo as getDownloadInfo
* @borrows AccountServices.updateDownloadInfo as updateDownloadInfo
* @borrows AccountServices.isLoggedIn as isLoggedIn
* @borrows AccountServices.checkAndSignalForAccessToken as checkAndSignalForAccessToken
* @borrows AccountServices.logOut as logOut
*
* @borrows AccountServices.connected as connected
* @borrows AccountServices.disconnected as disconnected
* @borrows AccountServices.myUsernameChanged as myUsernameChanged
* @borrows AccountServices.downloadInfoChanged as downloadInfoChanged
* @borrows AccountServices.findableByChanged as findableByChanged
* @borrows AccountServices.loggedInChanged as loggedInChanged
*/
Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged)
Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged)
Q_PROPERTY(QString findableBy READ getFindableBy WRITE setFindableBy NOTIFY findableByChanged)