Mirrors/overte-Armored-Dragon
3
0
Fork 0
mirror of https://github.com/Armored-Dragon/overte.git synced 2025-03-11 16:13:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

AddressManager JSDoc

Browse source
This commit is contained in:
David Rowe 2019-12-10 07:34:17 +13:00
parent 9dc1167e73
commit 3a48a97a90
1 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -68,6 +68,66 @@ const QString GET_PLACE = "/api/v1/places/%1";
* <em>Read-only.</em>
*/
/**jsdoc
* The <code>AddressMAnager</code> API provides facilities related to your current location in the metaverse.
*
* @namespace AddressManager
*
* @hifi-interface
* @hifi-client-entity
* @hifi-avatar
*
* @deprecated This API is deprecated and will be removed. Use the {@link location} or {@link Window|Window.location} APIs
* instead.
*
* @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid(0)|Uuid.NULL} if you're not
* connected to the domain or are in a serverless domain.
* <em>Read-only.</em>
* @property {string} hostname - The name of the domain for your current metaverse address (e.g., <code>"DomainName"</code>,
* <code>localhost</code>, or an IP address). Is blank if you're in a serverless domain.
* <em>Read-only.</em>
* @property {string} href - Your current metaverse address (e.g., <code>"hifi://domainname/15,-10,26/0,0,0,1"</code>)
* regardless of whether or not you're connected to the domain. Starts with <code>"file:///"</code> if you're in a
* serverless domain.
* <em>Read-only.</em>
* @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>.
* @property {string} pathname - The location and orientation in your current <code>href</code> metaverse address
* (e.g., <code>"/15,-10,26/0,0,0,1"</code>).
* <em>Read-only.</em>
* @property {string} placename - The place name in your current <code>href</code> metaverse address
* (e.g., <code>"DomainName"</code>). Is blank if your <code>hostname</code> is an IP address.
* <em>Read-only.</em>
* @property {string} protocol - The protocol of your current <code>href</code> metaverse address (e.g., <code>"hifi"</code>).
* <em>Read-only.</em>
*
* @borrows location.handleLookupString as handleLookupString
* @borrows location.goToViewpointForPath as goToViewpointForPath
* @borrows location.goBack as goBack
* @borrows location.goForward as goForward
* @borrows location.goToLocalSandbox as goToLocalSandbox
* @borrows location.goToEntry as goToEntry
* @borrows location.goToUser as goToUser
* @borrows location.goToLastAddress as goToLastAddress
* @borrows location.canGoBack as canGoBack
* @borrows location.refreshPreviousLookup as refreshPreviousLookup
* @borrows location.storeCurrentAddress as storeCurrentAddress
* @borrows location.copyAddress as copyAddress
* @borrows location.copyPath as copyPath
* @borrows location.lookupShareableNameForDomainID as lookupShareableNameForDomainID
*
* @borrows location.lookupResultsFinished as lookupResultsFinished
* @borrows location.lookupResultIsOffline as lookupResultIsOffline
* @borrows location.lookupResultIsNotFound as lookupResultIsNotFound
* @borrows location.possibleDomainChangeRequired as possibleDomainChangeRequired
* @borrows location.locationChangeRequired as locationChangeRequired
* @borrows location.possibleDomainChangeRequiredViaICEForID as possibleDomainChangeRequiredViaICEForID
* @borrows location.pathChangeRequired as pathChangeRequired
* @borrows location.hostChanged as hostChanged
* @borrows location.goBackPossible as goBackPossible
* @borrows location.goForwardPossible as goForwardPossible
*/
class AddressManager : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY