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

Communities Class

Access general information about communities in your organization.

Namespace

ConnectApi

Communities Methods

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

getCommunities()

Returns a list of communities the context user has access to.

API Version

28.0

Signature

public static ConnectApi.CommunityPage getCommunities()

Return Value

Type: ConnectApi.CommunityPage Class

getCommunities(ConnectApi.CommunityStatus)

Returns a list of communities the context user has access to with the specified status.

API Version

28.0

Signature

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

Parameters

communityStatus
Type: ConnectApi.​​​CommunityStatus
communityStatus—Specifies the current status of the community. Values are:
  • Live
  • Inactive
  • UnderConstruction

Return Value

Type: ConnectApi.CommunityPage Class

getCommunity(String)

Returns information about the specific community.

API Version

28.0

Signature

public static ConnectApi.Community getCommunity(String communityId)

Parameters

communityId
Type: String
You must specify an ID for communityId. You cannot specify null or 'internal'.

Return Value

Type: ConnectApi.​Community Class