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
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
CommerceCart Class
CommerceCatalog Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
Communities Methods
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
ExternalEmailServices Class
ExternalManagedAccount Class
FulfillmentOrder Class
Knowledge Class
ManagedContent Class
ManagedTopics Class
Mentions Class
Missions Class
NextBestAction Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
SalesforceInbox Class
SmartDataDiscovery Class
SocialEngagement Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
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
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

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()

Get a list of communities 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 communities 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 community. Values are:
  • Live
  • Inactive
  • UnderConstruction

Return Value

Type: ConnectApi.CommunityPage

getCommunity(communityId)

Get information about a 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
ID of a community. You can’t specify null or internal.

Return Value

Type: ConnectApi.​Community