Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
AccessLevel Class
AccessType Enum
Address Class
Answers Class
ApexPages Class
Approval Class
Assert Class
AsyncInfo Class
AsyncOptions Class
Blob Class
Boolean Class
BusinessHours Class
CallbackStatus Enum
Callable Interface
Cases Class
Collator Class
Comparable Interface
Comparator Interface
Continuation Class
Cookie Class
Crypto Class
Custom Metadata Type Methods
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Domain Class
DomainCreator Class
DomainParser Class
DomainType Enum
Double Class
EmailMessages Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
ExternalServiceTest Class
FlexQueue Class
FeatureManagement Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult 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
Label Class
Label Methods
Limits Class
List Class
Location Class
LoggingLevel Enum
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
Object Class
OrgLimit Class
OrgLimits Class
PageReference Class
Packaging Class
Pattern Class
Queueable Interface
QueueableContext Interface
QueueableDuplicateSignature Class
QueueableDuplicateSignature.Builder Class
QuickAction Class
Quiddity Enum
RemoteObjectController
Request Class
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
Security Class
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision Class
SoqlStubProvider 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
UserManagement Class
UUID Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Label Class

Provides methods to retrieve a custom label or to check if translation exists for a label in a specific language and namespace. Label names are dynamically resolved at run time, overriding the user’s current language if a translation exists for the requested language. You can’t access labels that are protected in a different namespace.

Namespace

System

Usage

Custom labels enable developers to create multilingual applications by automatically presenting information (for example, help text or error messages) in a user’s native language. Custom labels have a limit of 1000 characters and can be accessed from Apex classes, Visualforce pages, Lightning pages, or Lightning components. For more information on custom labels, see Custom Labels in Salesforce Help.The label values can be translated into any language Salesforce supports. For supported languages, see Supported Languages in Salesforce Help.

  • To define custom labels, from Setup, in the Quick Find box, enter Custom Labels, and then select Custom Labels.
  • To assign translated values, turn on Translation Workbench and add translation mappings.
  • To retrieve the label for a default language setting or for a language and namespace, use System.Label.get(namespace, label, language).
  • To check if translation exists for a label and language in a namespace, use Label.translationExists(namespace, label, language).

In Apex code, you can refer to or instantiate a Label like this: 

1System.Label.myLabelName

For information on passing in labels into Aura components, see Getting Labels in Apex in the Lightning Aura Components Developer Guide.

Examples

This example returns True if an English label called MyLabel exists in the MyNamespace namespace.

1boolean exists = Label.translationExists('MyNamespace', 'MyLabel', 'en')

This example retrieves the custom label translation text for MyLabel in French.

1String value = Label.get('MyNamespace', 'MyLabel', 'fr')

Label Methods

The following are methods for Label.

get(namespace, label)

Retrieve a custom label for the specified namespace and a default language setting.

Signature

public static String get(String namespace, String label)

Parameters

namespace
Type: String
If the namespace name is null, it defaults to the package namespace. If the namespace name is an empty string, it implies the org namespace.
label
Type: String
The label name cannot be null or an empty string.

Return Value

Type: String

get(namespace, label, language)

Retrieve a custom label for the specified namespace and language.

Signature

public static String get(String namespace, String label, String language)

Parameters

namespace
Type: String
If the namespace name is null, it defaults to the package namespace. If the namespace name is an empty string, it implies the org namespace.
label
Type: String
The label name cannot be null or an empty string.
language
Type: String
This parameter must be a valid language ISO code. See the Platform-Only Languages section in Supported Languages in Salesforce Help.

Return Value

Type: String

translationExists(namespace, label, language)

Check if translation exists for a label and language in a namespace.

Signature

public static Boolean translationExists(string namespace, string label, string language)

Parameters

namespace
Type: String
If the namespace name is null, it defaults to the package namespace. If the namespace name is an empty string, it implies the org namespace.
label
Type: String
The label name cannot be null or an empty string.
language
Type: String
This parameter must be a valid language ISO code. See the Platform-Only Languages section in Supported Languages in Salesforce Help.

Return Value

Type: Boolean