Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Quick action launches a quick action specified by the special parameter qa. The value of this parameter must match the QuickActionName (API Name) of a quick action defined on objects of the provided object type. A valid object context must also be determined by the provided object selectors.

Opens a Pulsar page to view the specified document from the Content Library. The Id of the document can be provided as a parameter or as part of the path, but in the case of web content (HTML documents), all parameters will be passed along as URL parameters. Note: The launchdocument action works for Content Library documents, but other types of documents (Attachments and Salesforce Files not in the shared Content Libraries) should be opened using the view API.

This form of deep link is used solely as a callback/redirect URI related to external or internal custom OAuth 2.0 flows. Upon receiving this deep link, Pulsar will call any registered custom_oauth handlers. When it is used, any information added to the deep link as a hash fragment or parameters will be passed in the handler, for use by the custom application that set up the handler. For example the following custom application code will use this deep link behavior:

Code Block
languagejs
// register the handler first:
bridge.registerHandler('custom_oauth', function(oauthParams) {
  // expecting a token parameter or hash fragment to be appended to the 
  // deep link that will trigger this function, e.g.
  // pulsar://custom_oauth/callback#token=thisismytoken... or
  // pulsar://custom_oauth/callback?mytoken=thisismytoken...
  // fragment example:
  const token = oauthParams['fragment'].split('=')[1];
  // parameter example:
  const mytoken = oauthParams['mytoken'];
  // ...use the token  
});

// then, open a window to start the auth flow:
bridge.send(
  // request object
  {type: 'displayurl',
   data: {
    fullUrl: "https://authorization-server.com/auth?response_type=code" +
      "&client_id=29352735982374239857" +
      "&redirect_uri=pulsar://custom_oauth/callback" + // <-- deep link callback
      "&scope=create+delete" +
      "&state=xcoivjuywkdkhvusuye3kch",
    externalBrowser: false, // open inside Pulsar
   }
  }, // end request object
  // callback function
  function(responseData) {
    if (responseData.type === 'error') {
      console.log('An error occurred opening the OAuth endpoint');
    }
  } 
  // end callback function
);

The following are examples of deep links

...