Documentation on deep link scheme for Vuforia View?

[ClayHelberg]

Hi folks--

I'm interested in making an independent app that does some things and then transfers the user over to Vuforia View. I know that you can do at least a few things along these lines using a "deep link" of the form:

https://view.vuforia.com/command/<some command here>?<commmand params here>

For example, you can open Vuforia View and load a specific experience with something like this (which you can see on the "Share Experience" menu in Vuforia Studio:

https://view.vuforia.com/command/view-experience?url=...

I'd like to find out what the complete list of supported commands is. I know there's also command to set the experience service URL. Are there others? Is this documented somewhere?

--Clay

[RolandRaytchev · Accepted solution]

Hi @ClayHelberg ,

So far I know , this is not documented because it is not officially supported - means there is no compatibility guarded and every time could be changed. I know only few possible options which are currently available. These can be activated by clicking on a hyperlink on the device on which View is installed or by scanning a QR code with the link embedded in it.

You can call it  by clicking on a hyperlink on the device where the Vuforia View  is installed or by scanning a QR code which contains/implements such link.

Following options:

1. Open Experience (All platforms)

   vuforiaview://ptc.com/command/view-experience?url=[URL-encoded URL]
   https://view.vuforia.com/command/view-experience?url=[URL-encoded URL]​

2. Open View in Scan mode (All platforms)

   vuforiaview://ptc.com/command/open-scan-mode
   https://view.vuforia.com/command/open-scan-mode​

3. Open Experience from another Experience (All platforms)

   If an author sets window.location to the deep link for launching an Experience, the running Experience ends and the new Experience is loaded.
   The hyperlink widget can also be used, linking to the deep link for launching an Experience.  This all applies to the links for opening View in scan mode as well.
   Set an Experience Service	
   vuforiaview://ptc.com/command/set-experience-service?url=[URL-encoded URL]
   https://view.vuforia.com/command/set-experience-service?url=[URL-encoded URL]​

   Troubleshooting:
4. Open share dialog to send log file(s) to someone (All platforms)

   Open share dialog to send log file(s) to someone	
   vuforiaview://ptc.com/command/share-logs
   https://view.vuforia.com/command/share-logs​

5. Toggle log level (Android and windows) 

   vuforiaview://ptc.com/command/toggle-feature-flag?feature=verbose-logging
   https://view.vuforia.com/command/toggle-feature-flag?feature=verbose-logging
   ​

6.  Allow javaScript/web debugging /Android 

   vuforiaview://ptc.com/command/toggle-feature-flag?feature=web-content-debugging
   https://view.vuforia.com/command/toggle-feature-flag?feature=web-content-debugging
   ​

7. Enable verbose logging of HTTP cache
   (requires verbose-logging be enabled as well) Android (8.4.2+)

   vuforiaview://ptc.com/command/toggle-feature-flag?feature=verbose-http-cache
   https://view.vuforia.com/command/toggle-feature-flag?feature=verbose-http-cache
   ​

[ClayHelberg]

Thanks, Roland! I understand the "use at your own risk" aspect of this capability. Those are some very useful options you listed, I will be sure to try some of them out.