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
AccessType Enum
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
Network Constructors
Network Methods
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
Security Class (Pilot)
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision 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
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

Network Class

Represents a community.

Namespace

System

Usage

Use the method in the Network class to determine which community a user is currently logged into.

Network Constructors

The following are constructors for Network.

Network()

Creates a new instance of the System.Network class.

Signature

public Network()

Network Methods

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

communitiesLanding()

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

Signature

public static String communitiesLanding()

Return Value

Type: PageReference

Usage

If Communities isn’t enabled for the user’s organization or the user is currently in the internal organization, returns null.

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 Communities isn’t enabled for the user’s organization or the user is currently in the internal organization, returns null.

getLoginUrl(networkId)

Returns the absolute URL of the login page used by the community.

Signature

public static String getLoginUrl(String networkId)

Parameters

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

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform or Community Builder page used as the login page in the community.

getLogoutUrl(networkId)

Returns the absolute URL of the logout page used by the community.

Signature

public static String getLogoutUrl(String networkId)

Parameters

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

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform page, Community Builder page, or Web page used as the logout page in the community.

getNetworkId()

Returns the user’s current community.

Signature

public static String getNetworkId()

Return Value

Type: String

Usage

If Communities isn’t enabled for the user’s organization or the user is currently in the internal organization, returns null.

getSelfRegUrl(networkId)

Returns the absolute URL of the self-registration page used by the community.

Signature

public static String getSelfRegUrl(String networkId)

Parameters

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

Return Value

Type: String

Usage

Returns the full URL for the Lightning Platform or Community Builder page used as the self-registration page in the community.

loadAllPackageDefaultNetworkDashboardSettings()

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

Signature

public static Integer loadAllPackageDefaultNetworkDashboardSettings()

Return Value

Type: Integer

Usage

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

If Communities isn’t enabled for the user’s organization or the user is in the internal organization, returns 0.

loadAllPackageDefaultNetworkPulseSettings()

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

Signature

public static Integer loadAllPackageDefaultNetworkPulseSettings()

Return Value

Type: Integer

Usage

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

If Communities isn’t enabled for the user’s organization or the user is in the internal organization, returns 0.