Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
Address Class
Answers Class
ApexPages Class
Approval Class
Blob Class
Boolean Class
BusinessHours Class
Callable Interface
Cases Class
Comparable Interface
Continuation Class
Cookie Class
Crypto Class
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Double Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
FlexQueue Class
FeatureManagement Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Limits Class
List Class
Location Class
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
OrgLimit Class
OrgLimits Class
PageReference Class
Pattern Class
Queueable Interface
QueueableContext Interface
QuickAction Class
RemoteObjectController
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
SelectOption Class
Set Class
Site Class
SObject Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserInfo Methods
UserManagement Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

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

UserInfo Class

Contains methods for obtaining information about the context user.

Namespace

System

UserInfo Methods

The following are methods for UserInfo. All methods are static.

getDefaultCurrency()

Returns the context user's default currency code for multiple currency organizations or the organization's currency code for single currency organizations.

Signature

public static String getDefaultCurrency()

Return Value

Type: String

Usage

For Apex saved using Salesforce API version 22.0 or earlier, getDefaultCurrency returns null for single currency organizations.

Note

getFirstName()

Returns the context user's first name

Signature

public static String getFirstName()

Return Value

Type: String

getLanguage()

Returns the context user's language

Signature

public static String getLanguage()

Return Value

Type: String

getLastName()

Returns the context user's last name

Signature

public static String getLastName()

Return Value

Type: String

getLocale()

Returns the context user's locale.

Signature

public static String getLocale()

Return Value

Type: String

Example

1String result = UserInfo.getLocale();
2System.assertEquals('en_US', result);

getName()

Returns the context user's full name. The format of the name depends on the language preferences specified for the organization.

Signature

public static String getName()

Return Value

Type: String

Usage

The format is one of the following:

  • FirstName LastName
  • LastName, FirstName

getOrganizationId()

Returns the context organization's ID.

Signature

public static String getOrganizationId()

Return Value

Type: String

getOrganizationName()

Returns the context organization's company name.

Signature

public static String getOrganizationName()

Return Value

Type: String

getProfileId()

Returns the context user's profile ID.

Signature

public static String getProfileId()

Return Value

Type: String

getSessionId()

Returns the session ID for the current session.

Signature

public static String getSessionId()

Return Value

Type: String

Usage

You can use getSessionId() both synchronously and asynchronously. In asynchronous Apex (Batch, Future, Queueable, or Scheduled Apex), this method returns the session ID only when the code is run by an active, valid user. When the code is run by an internal user, such as the automated process user or a proxy user, the method returns null.

As a best practice, ensure that your code handles both cases: when a session ID is or is not available.

getTimeZone()

Returns the current user’s local time zone.

Signature

public static System.TimeZone getTimeZone()

Return Value

Type: System.TimeZone

Example

1TimeZone tz = 
2  UserInfo.getTimeZone();
3System.debug(
4  'Display name: ' + 
5  tz.getDisplayName());
6System.debug(
7  'ID: ' + 
8  tz.getID());

getUiTheme()

Returns the preferred theme for the current user. Use getUiThemeDisplayed to determine the theme actually displayed to the current user.

Signature

public static String getUiTheme()

Return Value

Type: String

The preferred theme for the current user.

Valid values include:
  • Theme1—Obsolete Salesforce theme
  • Theme2—Salesforce Classic 2005 user interface theme
  • Theme3—Salesforce Classic 2010 user interface theme
  • Theme4d—Modern “Lightning Experience” Salesforce theme
  • Theme4t—Salesforce mobile app theme
  • Theme4u—Lightning Console theme
  • PortalDefault—Salesforce Customer Portal theme
  • Webstore—Salesforce AppExchange theme

getUiThemeDisplayed()

Returns the theme being displayed for the current user.

Signature

public static String getUiThemeDisplayed()

Return Value

Type: String

The theme being displayed for the current user

Valid values include:
  • Theme1—Obsolete Salesforce theme
  • Theme2—Salesforce Classic 2005 user interface theme
  • Theme3—Salesforce Classic 2010 user interface theme
  • Theme4d—Modern “Lightning Experience” Salesforce theme
  • Theme4t—Salesforce mobile app theme
  • Theme4u—Lightning Console theme
  • PortalDefault—Salesforce Customer Portal theme
  • Webstore—Salesforce AppExchange theme

getUserEmail()

Returns the current user’s email address.

Signature

public static String getUserEmail()

Return Value

Type: String

Example

1String emailAddress = 
2  UserInfo.getUserEmail();
3System.debug(
4  'Email address: ' + 
5  emailAddress);

getUserId()

Returns the context user's ID

Signature

public static String getUserId()

Return Value

Type: String

getUserName()

Returns the context user's login name.

Signature

public static String getUserName()

Return Value

Type: String

getUserRoleId()

Returns the context user's role ID.

Signature

public static String getUserRoleId()

Return Value

Type: String

getUserType()

Returns the context user's type.

Signature

public static String getUserType()

Return Value

Type: String

isCurrentUserLicensed(namespace)

Returns true if the context user has a license to the managed package denoted by the namespace. Otherwise, returns false.

Signature

public static Boolean isCurrentUserLicensed(String namespace)

Parameters

namespace
Type: String

Return Value

Type: Boolean

Usage

A TypeException is thrown if namespace is an invalid parameter.

isMultiCurrencyOrganization()

Specifies whether the organization uses multiple currencies.

Signature

public static Boolean isMultiCurrencyOrganization()

Return Value

Type: Boolean