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.

Communities Class

Get information about Experience Cloud sites in your org.

Namespace

ConnectApi

Communities Methods

These methods are for Communities. All methods are static.

getCommunities()

Get a list of Experience Cloud sites that the context user has access to.

API Version

28.0

Requires Chatter

No

Signature

public static ConnectApi.CommunityPage getCommunities()

Return Value

Type: ConnectApi.CommunityPage

getCommunities(communityStatus)

Get a list of Experience Cloud sites with the specified status that the context user has access to.

API Version

28.0

Requires Chatter

No

Signature

public static ConnectApi.CommunityPage getCommunities(ConnectApi.CommunityStatus communityStatus)

Parameters

communityStatus

Type: ConnectApi.​CommunityStatus

communityStatus—Status of the Experience Cloud site. Values are:

  • Live
  • Inactive
  • UnderConstruction

Return Value

Type: ConnectApi.CommunityPage

getCommunity(communityId)

Get information about an Experience Cloud site.

API Version

28.0

Available to Guest Users

35.0

Requires Chatter

No

Signature

public static ConnectApi.Community getCommunity(String communityId)

Parameters

communityId
Type: String
ID of an Experience Cloud site. You can’t specify null or internal.

Return Value

Type: ConnectApi.​Community