Make package require My Domain

Question

I've prepared a managed package that includes Lightning components, and the main one belongs to the FlexiPage that is shown when you open the application. I've installed it to a different org, but when the tab is open I just see an error message. Like this

I found it that this is because My Domain feature was not enabled in this org so I wonder: is there any way for me to check whether this feature is enabled and run this check before the package is installed or when the application is first run?

Answer 1

You could possibly use the following SOQL query to retrieve the Domain object details available in Salesforce.

[SELECT Id, CnameTarget, Domain, DomainType, OptionsExternalHttps FROM Domain]

This could be done on the onInstall() method of the System.InstallHandler interface provided within Apex to trigger activities on Managed Package installation and uninstallation.

global class PostInstallClass implements InstallHandler {

  global void onInstall(InstallContext context) {
    List<Domain> availableDomainList = [SELECT Id, CnameTarget, Domain, DomainType, OptionsExternalHttps FROM Domain]);

    //If Domains do not exist on the target org
    if(availableDomainList == null){

       //Throw Custom Exception to halt installation
    }
  }

}

Refer the Apex Developer Guide to understand more about how the InstallHandler Interface can be leveraged.