Newer Version Available

This content describes an older version of this product. View Latest

URL Class

Represents a uniform resource locator (URL) and provides access to parts of the URL. Enables access to the Salesforce instance URL.

Namespace

System

Usage

Use the methods of the System.URL class to create links to objects in your organization. Such objects can be files, images, logos, or records that you want to include in external emails, in activities, or in Chatter posts. For example, you can create a link to a file uploaded as an attachment to a Chatter post by concatenating the Salesforce base URL with the file ID, as shown in the following example:

1// Get a file uploaded through Chatter.
2ContentDocument doc = [SELECT Id FROM ContentDocument 
3          WHERE Title = 'myfile'];
4// Create a link to the file.
5String fullFileURL = URL.getSalesforceBaseUrl().toExternalForm() +
6   '/' + doc.id;
7system.debug(fullFileURL);

The following example creates a link to a Salesforce record. The full URL is created by concatenating the Salesforce base URL with the record ID.

1Account acct = [SELECT Id FROM Account WHERE Name = 'Acme' LIMIT 1];
2String fullRecordURL = URL.getSalesforceBaseUrl().toExternalForm() + '/' + acct.Id;

Example

In this example, the base URL and the full request URL of the current Salesforce server instance are retrieved. Next, a URL pointing to a specific account object is created. Finally, components of the base and full URL are obtained. This example prints out all the results to the debug log output.

1// Create a new account called Acme that we will create a link for later.
2Account myAccount = new Account(Name='Acme');
3insert myAccount;
4
5// Get the base URL.
6String sfdcBaseURL = URL.getSalesforceBaseUrl().toExternalForm();
7System.debug('Base URL: ' + sfdcBaseURL );       
8
9// Get the URL for the current request.
10String currentRequestURL = URL.getCurrentRequestUrl().toExternalForm();
11System.debug('Current request URL: ' + currentRequestURL);        
12
13// Create the account URL from the base URL.
14String accountURL = URL.getSalesforceBaseUrl().toExternalForm() + 
15                       '/' + myAccount.Id;
16System.debug('URL of a particular account: ' + accountURL); 
17
18// Get some parts of the base URL.
19System.debug('Host: ' + URL.getSalesforceBaseUrl().getHost());   
20System.debug('Protocol: ' + URL.getSalesforceBaseUrl().getProtocol());
21
22// Get the query string of the current request.
23System.debug('Query: ' + URL.getCurrentRequestUrl().getQuery());

URL Constructors

The following are constructors for URL.

Url(spec)

Creates a new instance of the URL class using the specified string representation of the URL.

Signature

public Url(String spec)

Parameters

spec: Type: String; The string to parse as a URL.

Url(context, spec)

Creates a new instance of the URL class by parsing the specified spec within the specified context.

Signature

public Url(Url context, String spec)

Parameters

context: Type: URL; The context in which to parse the specification.
spec: Type: String; The string to parse as a URL.

Usage

The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :

1<scheme>://<authority><path>?<query>#<fragment>

For more information about the arguments of this constructor, see the corresponding URL(java.net.URL, java.lang.String) constructor for Java.

Url(protocol, host, file)

Creates a new instance of the URL class using the specified protocol, host, and file on the host. The default port for the specified protocol is used.

Signature

public Url(String protocol, String host, String file)

Parameters

protocol: Type: String; The protocol name for this URL.
host: Type: String; The host name for this URL.
file: Type: String; The file name for this URL.

Url(protocol, host, port, file)

Creates a new instance of the URL class using the specified protocol, host, port, and file on the host.

Signature

public Url(String protocol, String host, Integer port, String file)

Parameters

protocol: Type: String; The protocol name for this URL.
host: Type: String; The host name for this URL.
port: Type: Integer; The port number for this URL.
file: Type: String; The file name for this URL.

URL Methods

The following are methods for URL.

getAuthority()

Returns the authority portion of the current URL.

Signature

public String getAuthority()

Return Value

Type: String

getCurrentRequestUrl()

Returns the URL of an entire request on a Salesforce instance.

Signature

public static System.URL getCurrentRequestUrl()

Return Value

Type: System.URL

Usage

An example of a URL for an entire request is https://yourInstance.salesforce.com/apex/myVfPage.apexp.

getDefaultPort()

Returns the default port number of the protocol associated with the current URL.

Signature

public Integer getDefaultPort()

Return Value

Type: Integer

Usage

Returns -1 if the URL scheme or the stream protocol handler for the URL doesn't define a default port number.

getFile()

Returns the file name of the current URL.

Signature

public String getFile()

Return Value

Type: String

getFileFieldURL(entityId, fieldName)

Returns the download URL for a file attachment.

Signature

public static String getFileFieldURL(String entityId, String fieldName)

Parameters

entityId: Type: String; Specifies the ID of the entity that holds the file data.
fieldName: Type: String; Specifies the API name of a file field component, such as AttachmentBody.

Return Value

Type: String

Usage

Example:

Example

1String fileURL = 
2  URL.getFileFieldURL(
3    '087000000000123' ,
4    'AttachmentBody');

getHost()

Returns the host name of the current URL.

Signature

public String getHost()

Return Value

Type: String

getOrgDomainUrl()

Returns the canonical URL for your org. For example, https://yourDomain.my.salesforce.com or, for orgs without My Domain enabled, https://yourInstance.salesforce.com.

Signature

public static System.Url getOrgDomainUrl()

Return Value

Type: System.URL

getOrgDomainUrl() always returns the same domain for your org, regardless of context. Use this method to build links to record URLs that work both in Lightning Experience and in Salesforce Classic, or as the domain when making API calls to your org.

Usage

Use getOrgDomainUrl() to interact with Salesforce REST and SOAP APIs in Apex code. Get endpoints for User Interface API calls, for creating and customizing picklist value sets and custom fields, and more.

getOrgDomainUrl() can access the domain URL only for the org in which the Apex code is running.

You don't need a RemoteSiteSetting for your org to interact with the Salesforce APIs using domain URLs retrieved with this method. To bypass remote site settings, My Domain must be enabled in your org.

Example

This example uses the Salesforce REST API to get organization limit values. For information on limits, see Limits in the REST API Developer Guide.

1Http h = new Http();
2HttpRequest req = new HttpRequest();  
3req.setEndpoint(Url.getOrgDomainUrl().toExternalForm()
4   + '/services/data/v44.0/limits');
5req.setMethod('GET');
6req.setHeader('Authorization', 'Bearer ' + UserInfo.getSessionId());
7HttpResponse res = h.send(req);

getPath()

Returns the path portion of the current URL.

Signature

public String getPath()

Return Value

Type: String

getPort()

Returns the port of the current URL.

Signature

public Integer getPort()

Return Value

Type: Integer

getProtocol()

Returns the protocol name of the current URL, such as, https.

Signature

public String getProtocol()

Return Value

Type: String

getQuery()

Returns the query portion of the current URL.

Signature

public String getQuery()

Return Value

Type: String

Usage

Returns null if no query portion exists.

getRef()

Returns the anchor of the current URL.

Signature

public String getRef()

Return Value

Type: String

Usage

Returns null if no query portion exists.

getSalesforceBaseUrl()

Returns the URL of the Salesforce instance.

Signature

public static System.URL getSalesforceBaseUrl()

Return Value

Type: System.URL

Returns the host name for the current connection: for example, https://MyDomainName.my.salesforce.com, https://MyDomainName.lightning.force.com, or, for orgs without My Domain enabled, https://yourInstance.salesforce.com or https://yourInstance.lightning.force.com.

getUserInfo()

Gets the UserInfo portion of the current URL.

Signature

public String getUserInfo()

Return Value

Type: String

Usage

Returns null if no UserInfo portion exists.

sameFile(URLToCompare)

Compares the current URL with the specified URL object, excluding the fragment component.

Signature

public Boolean sameFile(System.URL URLToCompare)

Parameters

URLToCompare: Type: System.URL

Return Value

Type: Boolean

Returns true if both URL objects reference the same remote resource; otherwise, returns false.

Usage

For more information about the syntax of URIs and fragment components, see RFC3986.

toExternalForm()

Returns a string representation of the current URL.

Signature

public String toExternalForm()

Return Value

Type: String

Apex Developer Guide

URL Class

Namespace

Usage

Example

URL Constructors

Url(spec)

Signature

Parameters

Url(context, spec)

Signature

Parameters

Usage

Url(protocol, host, file)

Signature

Parameters

Url(protocol, host, port, file)

Signature

Parameters

URL Methods

getAuthority()

Signature

Return Value

getCurrentRequestUrl()

Signature

Return Value

Usage

getDefaultPort()

Signature

Return Value

Usage

getFile()

Signature

Return Value

getFileFieldURL(entityId, fieldName)

Signature

Parameters

Return Value

Usage

Example

getHost()

Signature

Return Value

getOrgDomainUrl()

Signature

Return Value

Usage

Example

See Also

getPath()

Signature

Return Value

getPort()

Signature

Return Value

getProtocol()

Signature

Return Value

getQuery()

Signature

Return Value

Usage

getRef()

Signature

Return Value

Usage

getSalesforceBaseUrl()

Signature

Return Value

See Also

getUserInfo()

Signature

Return Value

Usage

sameFile(URLToCompare)

Signature

Parameters

Return Value

Usage

toExternalForm()