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
commonserviceexcellence 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
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance 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
sfdw Namespace
sfsqlquery 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
FeatureManagement Class
FeatureManagement Methods
Finalizer Interface
FinalizerContext Interface
FlexQueue Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
IntegrationTest Class (Developer Preview)
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Label Class
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
ParentJobResult Enum
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

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

FeatureManagement Class

Use the methods in the System.FeatureManagement class to check and modify the values of feature parameters, and to show or hide custom objects and custom permissions in your subscribers’ orgs.

Namespace

System

Usage

For information about feature parameters, see Manage Features in Second Generation Managed Packages in the Second-Generation Managed Packaging Developer Guide, or Manage Features in First-Generation Managed Packages in the First-Generation Managed Packaging Developer Guide.

The set methods (setPackageBooleanValue, setPackageDateValue, setPackageIntegerValue) use DML operations on setup sObjects. To learn more about mixing operations in a test, see Mixed DML Operations in Test Methods.

FeatureManagement Methods

The following are methods for FeatureManagement.

changeProtection(apiName, typeApiName, protection)

Hides or reveals custom permissions, or reveals custom objects, in your subscriber’s org.

Signature

public static void changeProtection(String apiName, String typeApiName, String protection)

Parameters

  • apiName: Type: String The API name of the custom object or custom permission to show or hide—for example, 'MyCustomObject__c' or 'MyCustomPermission'.
  • typeApiName: Type: String The API name of the type that you want to show or hide: 'CustomObject' or 'CustomPermission'.
  • protection: Type: String

    To show a custom object or custom permission, 'Unprotected'.

    To hide a custom permission, 'Protected'.

Return Value

Type: void

Usage

For custom permissions, you can toggle the protected value indefinitely. However, after you’ve released unprotected objects to subscribers, you can’t set visibility to Protected. Be sure to protect any custom objects that you want to hide before you release the first package version that contains them.

Warning

To hide custom permissions in released packages:
1FeatureManagement.changeProtection('YourCustomPermissionName', 'CustomPermission',
2    'Protected');
To unhide custom permissions and custom objects in released packages:
1FeatureManagement.changeProtection('YourCustomPermissionName', 'CustomPermission',
2    'Unprotected');
1FeatureManagement.changeProtection('YourCustomObjectName__c', 'CustomObject',
2    'Unprotected');

checkPackageBooleanValue(apiName)

Checks the value__c value of the FeatureParameterBoolean__c record for a feature parameter in your subscriber’s org. You set the record’s value using setPackageBooleanValue(apiName, value).

Signature

public static Boolean checkPackageBooleanValue(String apiName)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to check—for example, 'SpecialAccessAvailable'.

Return Value

Type: Boolean

The value that’s currently assigned to the value__c field on the FeatureParameterBoolean__c record that associates the feature parameter with its related license.

checkPackageDateValue(apiName)

Checks the value__c value of the FeatureParameterDate__c record for a feature parameter in your subscriber’s org. You can set the record’s value using setPackageDateValue(apiName, value).

Signature

public static Date checkPackageDateValue(String apiName)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to check—for example, 'TrialExpirationDate'.

Return Value

Type: Date

The value that’s currently assigned to the value__c field on the FeatureParameterDate__c record that associates the feature parameter with its related license.

checkPackageIntegerValue(apiName)

Checks the value__c value of the FeatureParameterInteger__c record for a feature parameter in your subscriber’s org. You can set the record’s value using setPackageIntegerValue(apiName, value).

Signature

public static Integer checkPackageIntegerValue(String apiName)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to check—for example, 'NumberOfLicenses'.

Return Value

Type: Integer

The value that’s currently assigned to the value__c field on the FeatureParameterInteger__c record that associates the feature parameter with its related license.

checkPermission(apiName)

Checks whether a custom permission is enabled.

Signature

public static Boolean checkPermission(String apiName)

Parameters

  • apiName: Type: String The API name of the custom permission to check the value of—for example, 'MyCustomPermission'.

Return Value

Type: Boolean

Shows whether the permission is enabled (true) or disabled (false).

setPackageBooleanValue(apiName, value)

Sets the value__c value of the FeatureParameterBoolean__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageBooleanValue(apiName).

Signature

public static void setPackageBooleanValue(String apiName, Boolean value)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to set—for example, 'SpecialAccessAvailable'.
  • value: Type: Boolean The value to assign to the value__c field on the FeatureParameterBoolean__c record that associates the feature parameter with its related license.

Return Value

Type: void

setPackageDateValue(apiName, value)

Sets the value__c value of the FeatureParameterDate__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageDateValue(apiName).

Signature

public static void setPackageDateValue(String apiName, Date value)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to set—for example, 'TrialExpirationDate'.
  • value: Type: Date The value to assign to the value__c field on the FeatureParameterDate__c record that associates the feature parameter with its related license.

Return Value

Type: void

setPackageIntegerValue(apiName, value)

Sets the value__c value of the FeatureParameterInteger__c record for a subscriber-to-LMO feature parameter in your subscriber’s org. You can check the record’s value using checkPackageIntegerValue(apiName).

Signature

public static void setPackageIntegerValue(String apiName, Integer value)

Parameters

  • apiName: Type: String The fullName__c value of the feature parameter whose value you want to set—for example, 'NumberOfLicenses'.
  • value: Type: Integer The value to assign to the value__c field on the FeatureParameterInteger__c record that associates the feature parameter with its related license.

Return Value

Type: void