Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-06 10:43:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Further JSDoc updates for serverless domains

Browse source
This commit is contained in:
David Rowe 2018-04-20 09:52:35 +12:00
parent 08defea755
commit 0552a7242a
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
libraries/networking/src/AddressManager.h
View file

@ -34,15 +34,16 @@ const QString GET_PLACE = "/api/v1/places/%1";
* *
* @namespace location * @namespace location
* @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not * @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not
* connected to the domain. * connected to the domain or are at a serverless domain.
* <em>Read-only.</em> * <em>Read-only.</em>
* @property {Uuid} domainId - Synonym for <code>domainId</code>. <em>Read-only.</em> <strong>Deprecated:</strong> This property * @property {Uuid} domainId - Synonym for <code>domainId</code>. <em>Read-only.</em> <strong>Deprecated:</strong> This property
* is deprecated and will soon be removed. * is deprecated and will soon be removed.
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"AvatarIsland"</code>, * @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"AvatarIsland"</code>,
* <code>localhost</code>, an IP address, or the file path to a serverless domain). * <code>localhost</code>, or an IP address). Is blank if you're at a serverless domain.
* <em>Read-only.</em> * <em>Read-only.</em>
* @property {string} href - Your current metaverse address (e.g., <code>"hifi://avatarisland/15,-10,26/0,0,0,1"</code>) * @property {string} href - Your current metaverse address (e.g., <code>"hifi://avatarisland/15,-10,26/0,0,0,1"</code>)
* regardless of whether or not you're connected to the domain. * regardless of whether or not you're connected to the domain. Starts with <code>"file:///"</code> if at a serverless
* domain.
* <em>Read-only.</em> * <em>Read-only.</em>
* @property {boolean} isConnected - <code>true</code> if you're connected to the domain in your current <code>href</code> * @property {boolean} isConnected - <code>true</code> if you're connected to the domain in your current <code>href</code>
* metaverse address, otherwise <code>false</code>. * metaverse address, otherwise <code>false</code>.