Newer Version Available
Communities Class
Access general information about communities in your organization.
Namespace
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
Requires Chatter
No
Signature
public static ConnectApi.CommunityPage getCommunities()
Return Value
Type: ConnectApi.CommunityPage
getCommunities(communityStatus)
Returns a list of communities the context user has access
to with the specified status.
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 community. Values are:
- Live
- Inactive
- UnderConstruction
Return Value
Type: ConnectApi.CommunityPage
getCommunity(communityId)
Returns information about the specific community.
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
- Specify an ID for communityId. You cannot specify null or 'internal'.
Return Value
Type: ConnectApi.Community