//// AccountServicesScriptingInterface.h// interface/src/scripting//// Created by Thijs Wenker on 9/10/14.// Copyright 2014 High Fidelity, Inc.// Copyright 2023 Overte e.V.//// Distributed under the Apache License, Version 2.0.// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html// SPDX-License-Identifier: Apache-2.0//#ifndef hifi_AccountServicesScriptingInterface_h#define hifi_AccountServicesScriptingInterface_h#include <QObject>#include <QString>#include <QStringList>#include <AccountManager.h>#include <DiscoverabilityManager.h>#include <ScriptValue.h>class ScriptEngine;class DownloadInfoResult {public: DownloadInfoResult(); QList<float> downloading; // List of percentages float pending;};Q_DECLARE_METATYPE(DownloadInfoResult)ScriptValue DownloadInfoResultToScriptValue(ScriptEngine* engine, const DownloadInfoResult& result);bool DownloadInfoResultFromScriptValue(const ScriptValue& object, DownloadInfoResult& result);class AccountServicesScriptingInterface : public QObject { Q_OBJECT /*@jsdoc * The <code>AccountServices</code> API provides functions that give information on user connectivity, visibility, and * asset download progress. * * @hifi-interface * @hifi-client-entity * @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>. * <em>Read-only.</em> * @property {string} findableBy - The user's visibility to other users: * <ul> * <li><code>"none"</code> — user appears offline.</li> * <li><code>"friends"</code> — user is visible only to friends.</li> * <li><code>"connections"</code> — user is visible to friends and connections.</li> * <li><code>"all"</code> — user is visible to everyone.</li> * </ul> * @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in * — 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> — user appears offline.</li> * <li><code>"friends"</code> — user is visible only to friends.</li> * <li><code>"connections"</code> — user is visible to friends and connections.</li> * <li><code>"all"</code> — user is visible to everyone.</li> * </ul> * @property {string} metaverseServerURL - The directory server that the user is authenticated against when logged in * — 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> — user appears offline.</li> * <li><code>"friends"</code> — user is visible only to friends.</li> * <li><code>"connections"</code> — user is visible to friends and connections.</li> * <li><code>"all"</code> — user is visible to everyone.</li> * </ul> * @property {string} metaverseServerURL - The directory server that the user is authenticated against when logged in * — 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) Q_PROPERTY(QUrl metaverseServerURL READ getMetaverseServerURL CONSTANT)public: static AccountServicesScriptingInterface* getInstance(); const QString getUsername() const; bool loggedIn() const { return _loggedIn; } QUrl getMetaverseServerURL() { return DependencyManager::get<AccountManager>()->getMetaverseServerURL(); }public slots: /*@jsdoc * Gets information on the download progress of assets in the domain. * @function AccountServices.getDownloadInfo * @returns {AccountServices.DownloadInfoResult} Information on the download progress of assets. */ DownloadInfoResult getDownloadInfo(); /*@jsdoc * Triggers a {@link AccountServices.downloadInfoChanged|downloadInfoChanged} signal with information on the current * download progress of the assets in the domain. * @function AccountServices.updateDownloadInfo */ void updateDownloadInfo(); /*@jsdoc * Checks whether the user is logged in. * @function AccountServices.isLoggedIn * @returns {boolean} <code>true</code> if the user is logged in, <code>false</code> if not. * @example <caption>Report whether you are logged in.</caption> * var isLoggedIn = AccountServices.isLoggedIn(); * print("You are logged in: " + isLoggedIn); // true or false */ bool isLoggedIn(); /*@jsdoc * The function returns the login status of the user and prompts the user to log in (with a login dialog) if they're not already logged in. * @function AccountServices.checkAndSignalForAccessToken * @returns {boolean} <code>true</code> if the user is logged in, <code>false</code> if not. */ bool checkAndSignalForAccessToken(); /*@jsdoc * Logs the user out. * @function AccountServices.logOut */ void logOut(); /*@jsdoc * Updates Directory Server URL in AccountManager. It's called by Login window after Directory Server URL is changed. * @function AccountServices.updateAuthURLFromMetaverseServerURL */ void updateAuthURLFromMetaverseServerURL();private slots: void loggedOut(); void checkDownloadInfo(); QString getFindableBy() const; void setFindableBy(const QString& discoverabilityMode); void discoverabilityModeChanged(Discoverability::Mode discoverabilityMode); void onUsernameChanged(const QString& username);signals: /*@jsdoc * Not currently used. * @function AccountServices.connected * @returns {Signal} */ void connected(); /*@jsdoc * Triggered when the user logs out. * @function AccountServices.disconnected * @param {string} reason - Has the value, <code>"logout"</code>. * @returns {Signal} */ void disconnected(const QString& reason); /*@jsdoc * Triggered when the username logged in with changes, i.e., when the user logs in or out. * @function AccountServices.myUsernameChanged * @param {string} username - The user name of the user logged in. If there is no user logged in, it is <code>""</code>. * @returns {Signal} * @example <caption>Report when your username changes.</caption> * AccountServices.myUsernameChanged.connect(function (username) { * print("Username changed: " + username); * }); */ void myUsernameChanged(const QString& username); /*@jsdoc * Triggered when the download progress of the assets in the domain changes. * @function AccountServices.downloadInfoChanged * @param {AccountServices.DownloadInfoResult} downloadInfo - Information on the download progress of assets. * @returns {Signal} */ void downloadInfoChanged(DownloadInfoResult info); /*@jsdoc * Triggered when the user's visibility to others changes. * @function AccountServices.findableByChanged * @param {string} findableBy - The user's visibility to other people: * <ul> * <li><code>"none"</code> — user appears offline.</li> * <li><code>"friends"</code> — user is visible only to friends.</li> * <li><code>"connections"</code> — user is visible to friends and connections.</li> * <li><code>"all"</code> — user is visible to everyone.</li> * </ul> * @returns {Signal} * @example <caption>Report when your visiblity changes.</caption> * AccountServices.findableByChanged.connect(function (findableBy) { * print("Findable by changed: " + findableBy); * }); * * var originalFindableBy = AccountServices.findableBy; * Script.setTimeout(function () { * // Change visiblity. * AccountServices.findableBy = originalFindableBy === "none" ? "all" : "none"; * }, 2000); * Script.setTimeout(function () { * // Restore original visibility. * AccountServices.findableBy = originalFindableBy; * }, 4000); */ void findableByChanged(const QString& discoverabilityMode); /*@jsdoc * Triggered when the login status of the user changes. * @function AccountServices.loggedInChanged * @param {boolean} loggedIn - <code>true</code> if the user is logged in, <code>false</code> if not. * @returns {Signal} * @example <caption>Report when your login status changes.</caption> * AccountServices.loggedInChanged.connect(function(loggedIn) { * print("Logged in: " + loggedIn); * }); */ void loggedInChanged(bool loggedIn);private: AccountServicesScriptingInterface(); ~AccountServicesScriptingInterface(); bool _downloading; bool _loggedIn{ false };};#endif // hifi_AccountServicesScriptingInterface_h
//
// AccountServicesScriptingInterface.h
// interface/src/scripting
//
// Created by Thijs Wenker on 9/10/14.
// Copyright 2014 High Fidelity, Inc.
// Copyright 2023 Overte e.V.
//
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
// SPDX-License-Identifier: Apache-2.0
//
#ifndef hifi_AccountServicesScriptingInterface_h
#define hifi_AccountServicesScriptingInterface_h
#include <QObject>
#include <QString>
#include <QStringList>
#include <AccountManager.h>
#include <DiscoverabilityManager.h>
#include <ScriptValue.h>
class ScriptEngine;
class DownloadInfoResult {
public:
DownloadInfoResult();
QList<float> downloading; // List of percentages
float pending;
};
Q_DECLARE_METATYPE(DownloadInfoResult)
ScriptValue DownloadInfoResultToScriptValue(ScriptEngine* engine, const DownloadInfoResult& result);
bool DownloadInfoResultFromScriptValue(const ScriptValue& object, DownloadInfoResult& result);
class AccountServicesScriptingInterface : public QObject {
Q_OBJECT
/*@jsdoc
* The <code>AccountServices</code> API provides functions that give information on user connectivity, visibility, and
* asset download progress.
*
* @hifi-interface
* @hifi-client-entity
* @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>.
* <em>Read-only.</em>
* @property {string} findableBy - The user's visibility to other users:
* <ul>
* <li><code>"none"</code> — user appears offline.</li>
* <li><code>"friends"</code> — user is visible only to friends.</li>
* <li><code>"connections"</code> — user is visible to friends and connections.</li>
* <li><code>"all"</code> — user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in
* — 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> — user appears offline.</li>
* <li><code>"friends"</code> — user is visible only to friends.</li>
* <li><code>"connections"</code> — user is visible to friends and connections.</li>
* <li><code>"all"</code> — user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The directory server that the user is authenticated against when logged in
* — 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> — user appears offline.</li>
* <li><code>"friends"</code> — user is visible only to friends.</li>
* <li><code>"connections"</code> — user is visible to friends and connections.</li>
* <li><code>"all"</code> — user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The directory server that the user is authenticated against when logged in
* — 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)
Q_PROPERTY(QUrl metaverseServerURL READ getMetaverseServerURL CONSTANT)
public:
static AccountServicesScriptingInterface* getInstance();
const QString getUsername() const;
bool loggedIn() const { return _loggedIn; }
QUrl getMetaverseServerURL() { return DependencyManager::get<AccountManager>()->getMetaverseServerURL(); }
public slots:
/*@jsdoc
* Gets information on the download progress of assets in the domain.
* @function AccountServices.getDownloadInfo
* @returns {AccountServices.DownloadInfoResult} Information on the download progress of assets.
*/
DownloadInfoResult getDownloadInfo();
/*@jsdoc
* Triggers a {@link AccountServices.downloadInfoChanged|downloadInfoChanged} signal with information on the current
* download progress of the assets in the domain.
* @function AccountServices.updateDownloadInfo
*/
void updateDownloadInfo();
/*@jsdoc
* Checks whether the user is logged in.
* @function AccountServices.isLoggedIn
* @returns {boolean} <code>true</code> if the user is logged in, <code>false</code> if not.
* @example <caption>Report whether you are logged in.</caption>
* var isLoggedIn = AccountServices.isLoggedIn();
* print("You are logged in: " + isLoggedIn); // true or false
*/
bool isLoggedIn();
/*@jsdoc
* The function returns the login status of the user and prompts the user to log in (with a login dialog) if they're not already logged in.
* @function AccountServices.checkAndSignalForAccessToken
* @returns {boolean} <code>true</code> if the user is logged in, <code>false</code> if not.
*/
bool checkAndSignalForAccessToken();
/*@jsdoc
* Logs the user out.
* @function AccountServices.logOut
*/
void logOut();
/*@jsdoc
* Updates Directory Server URL in AccountManager. It's called by Login window after Directory Server URL is changed.
* @function AccountServices.updateAuthURLFromMetaverseServerURL
*/
void updateAuthURLFromMetaverseServerURL();
private slots:
void loggedOut();
void checkDownloadInfo();
QString getFindableBy() const;
void setFindableBy(const QString& discoverabilityMode);
void discoverabilityModeChanged(Discoverability::Mode discoverabilityMode);
void onUsernameChanged(const QString& username);
signals:
/*@jsdoc
* Not currently used.
* @function AccountServices.connected
* @returns {Signal}
*/
void connected();
/*@jsdoc
* Triggered when the user logs out.
* @function AccountServices.disconnected
* @param {string} reason - Has the value, <code>"logout"</code>.
* @returns {Signal}
*/
void disconnected(const QString& reason);
/*@jsdoc
* Triggered when the username logged in with changes, i.e., when the user logs in or out.
* @function AccountServices.myUsernameChanged
* @param {string} username - The user name of the user logged in. If there is no user logged in, it is <code>""</code>.
* @returns {Signal}
* @example <caption>Report when your username changes.</caption>
* AccountServices.myUsernameChanged.connect(function (username) {
* print("Username changed: " + username);
* });
*/
void myUsernameChanged(const QString& username);
/*@jsdoc
* Triggered when the download progress of the assets in the domain changes.
* @function AccountServices.downloadInfoChanged
* @param {AccountServices.DownloadInfoResult} downloadInfo - Information on the download progress of assets.
* @returns {Signal}
*/
void downloadInfoChanged(DownloadInfoResult info);
/*@jsdoc
* Triggered when the user's visibility to others changes.
* @function AccountServices.findableByChanged
* @param {string} findableBy - The user's visibility to other people:
* <ul>
* <li><code>"none"</code> — user appears offline.</li>
* <li><code>"friends"</code> — user is visible only to friends.</li>
* <li><code>"connections"</code> — user is visible to friends and connections.</li>
* <li><code>"all"</code> — user is visible to everyone.</li>
* </ul>
* @returns {Signal}
* @example <caption>Report when your visiblity changes.</caption>
* AccountServices.findableByChanged.connect(function (findableBy) {
* print("Findable by changed: " + findableBy);
* });
*
* var originalFindableBy = AccountServices.findableBy;
* Script.setTimeout(function () {
* // Change visiblity.
* AccountServices.findableBy = originalFindableBy === "none" ? "all" : "none";
* }, 2000);
* Script.setTimeout(function () {
* // Restore original visibility.
* AccountServices.findableBy = originalFindableBy;
* }, 4000);
*/
void findableByChanged(const QString& discoverabilityMode);
/*@jsdoc
* Triggered when the login status of the user changes.
* @function AccountServices.loggedInChanged
* @param {boolean} loggedIn - <code>true</code> if the user is logged in, <code>false</code> if not.
* @returns {Signal}
* @example <caption>Report when your login status changes.</caption>
* AccountServices.loggedInChanged.connect(function(loggedIn) {
* print("Logged in: " + loggedIn);
* });
*/
void loggedInChanged(bool loggedIn);
private:
AccountServicesScriptingInterface();
~AccountServicesScriptingInterface();
bool _downloading;
bool _loggedIn{ false };
};
#endif // hifi_AccountServicesScriptingInterface_h