Welcome to OpenFin Docs

Explore our guides, resources and references for building with OpenFin

Get Started

Deep linking

Introduction

The RVM permits deep linking to an OpenFin application from anywhere that can invoke a “link” like a browser, email client, or another OpenFin application. The RVM uses a custom protocol handler to invoke an application, if not already running, and pass context to a specific location within an OpenFin application via a uniform resource identifier (URI).

In order to leverage the deep linking feature in your application, you must use the “args” object in fin.desktop.main for processing added parameters on launch and the “args” object on the run-requested application event if your application is already running.

Example Deep Link

fins://mydomain.com/path-to-manifest/app.json?$$parameter1=value1&$$parameter2=value2

Example JavaScript

// On application launch parameters are passed through
fin.desktop.main(function(args) { 
   //args parameter contains deep link context
   console.log(args.parameter1);
}) 
// If the app is already running, parameters are passed through the 
//“run-requested” event 
app.addEventListener("run-requested", function (event) { 
   if(event.userAppConfigArgs){ 
      //args parameter contains deep link context
      console.log(event.userAppConfigArgs.parameter1); 
   } 
})

Updated 26 days ago


Deep linking


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.