Force.com Apex Code Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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(String 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(String)

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 Force.com or Community Designer page used as the login page in the community.

getLogoutUrl(String)

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 Force.com page, Community Designer 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(String)

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 Force.com or Community Designer page used as the self-registration page in the community.

loadAllPackageDefaultNetworkDashboardSettings()

Maps the dashboards from the Communities Analytics 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 Communities Analytics package is installed, maps the dashboards provided in the Communities Analytics package onto each community’s unconfigured dashboard settings. Returns the number of settings it configures. This method is invoked automatically during network creation and package installation. Typically, this method doesn’t need to be invoked manually.

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