Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
FormulaEval Namespace
fsccashflow Namespace
Functions 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
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search 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
Limits Class
List Class
Location Class
LoggingLevel Enum
Long Class
Map Class
Matcher Class
Math Class
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
Network Constructors
Network Methods
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

Network Class

Manage Experience Cloud sites.

Namespace

System

Network Constructors

Create an instance of the System.Network class.
The following are constructors for Network.

Network()

Creates a new instance of the System.Network class.

Signature

public Network()

Network Methods

Get the default landing page, login page, and self-registration page of a site. Asynchronously create site users and records. Get the login and logout URLs for a site. Get a user’s current site. Map dashboards and Insights reports.
The following are methods for Network. All methods are static.

communitiesLanding()

Returns a Page Reference to the default landing page for the Experience Cloud site. This is the first tab of the site.

Signature

public static String communitiesLanding()

Return Value

Type: PageReference

Usage

If digital experiences isn’t enabled for the user’s org or the user is currently in the internal org, returns null.

createExternalUserAsync(user, contact, account)

Asynchronously creates an Experience Cloud site user for the given account or contact and associates it with the site. This method processes requests in batches and then sends an email with login information to the user.

Signature

public static String createExternalUserAsync(SObject user, SObject contact, SObject account)

Parameters

user
Type: SObject (optional)
Information required to create a user.
contact
Type: SObject (optional)
The contact you want to associate the user with.
account
Type: SObject
The account you want to associate the user with.

Return Value

Type: String

Returns the UUID for the site user.

createRecordAsync(processType, mbObject)

Asynchronously creates case, lead, and custom object records. This method collects record creation requests and processes them in batches.

Signature

public static String createRecordAsync(String processType, SObject mbObject)

Parameters

processType
Type: String
The process you use to create records.
mbObject
Type: SObject
The records created for objects. Objects must be supported by the high-volume record creation.

Return Value

Type: String

Returns the UUID for the record created.

forwardToAuthPage(startURL)

Returns a Page Reference to the default login page. StartURL is included as a query paremeter for where to redirect after a successful login.

Signature

public static PageReference forwardToAuthPage(String startURL)

Parameters

startURL
Type: String

Return Value

Type: PageReference

Usage

If digital experiences isn’t enabled for the user’s org or the user is currently in the internal org, returns null.

getLoginUrl(networkId)

Returns the absolute URL of the login page used by the Experience Cloud site.

Signature

public static String getLoginUrl(String networkId)

Parameters

networkId
Type: String
The ID of the Experience Cloud site you’re retrieving this information for.

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform or Experience Builder page used as the login page in the Experience Cloud site.

getLogoutUrl(networkId)

Returns the absolute URL of the logout page used by the Experience Cloud site.

Signature

public static String getLogoutUrl(String networkId)

Parameters

networkId
Type: String
The ID of the Experience Cloud site you’re retrieving this information for.

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform page, Experience Builder page, or Web page used as the logout page in the Experience Cloud site.

getNetworkId()

Returns the user’s current Experience Cloud site.

Signature

public static String getNetworkId()

Return Value

Type: String

Usage

If digital experiences isn’t enabled for the user’s org or the user is currently in the internal org, returns null.

getSelfRegUrl(networkId)

Returns the absolute URL of the self-registration page used by the Experience Cloud site.

Signature

public static String getSelfRegUrl(String networkId)

Parameters

networkId
Type: String
The ID of the Experience Cloud site you’re retrieving this information for.

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform or Experience Builder page used as the self-registration page in the Experience Cloud site.

loadAllPackageDefaultNetworkDashboardSettings()

Maps the dashboards from the Salesforce Communities Management package onto each Experience Cloud site’s unconfigured dashboard settings. Returns the number of settings it configures.

Signature

public static Integer loadAllPackageDefaultNetworkDashboardSettings()

Return Value

Type: Integer

Usage

If digital experiences is enabled, and the Salesforce Communities Management package is installed, maps the dashboards provided in the package onto each Experience Cloud site’s unconfigured dashboard settings. Returns the number of settings it configures. This method is invoked automatically during site creation and package installation, but isn’t typically invoked manually.

If digital experiences isn’t enabled for the user’s org or the user is in the internal org, returns 0.

loadAllPackageDefaultNetworkPulseSettings()

Maps the Insights reports from the Salesforce Communities Management package onto each Experience Cloud site’s unconfigured Insights settings. Returns the number of settings it configures.

Signature

public static Integer loadAllPackageDefaultNetworkPulseSettings()

Return Value

Type: Integer

Usage

If digital experiences is enabled, and the Salesforce Communities Management package is installed, maps the Insights reports provided in the package onto each Experience Cloud site’s unconfigured Insights settings. Returns the number of settings it configures. This method is invoked automatically during site creation and package installation, but isn’t typically invoked manually.

If digital experiences isn’t enabled for the user’s org or the user is in the internal org, returns 0.