Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpActivation Class
CdpCalculatedInsight Class
CdpDataStreams Class
CdpIdentityResolution Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
IBusinessObjectivesAndRecsFamily Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
RecordFilterCriteriaFamily Class
Records Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
Zones Methods
Zones Test Methods
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Zones Class

Access information about Chatter Answers zones in your organization. Zones organize questions into logical groups, with each zone having its own focus and unique questions.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

Namespace

ConnectApi

Zones Methods

These methods are for Zones. All methods are static.

All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.

getZone(communityId, zoneId)

Get a zone.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Zone getZone(String communityId, String zoneId)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
The ID of a zone.

Return Value

Type: ConnectApi.Zone

getZones(communityId)

Get a list of zones.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ZonePage getZones(String communityId)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.

Return Value

Type: ConnectApi.ZonePage

getZones(communityId, pageParam, pageSize)

Get a page of zones.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Zone getZones(String communityId, Integer pageParam, Integer pageSize)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.
pageParam
Type: Integer
Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize
Type: Integer
Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ZonePage

searchInZone(communityId, zoneId, q, filter)

Search articles or questions in a zone.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Available to Guest Users

37.0

Requires Chatter

Yes

Signature

public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
A ZoneSearchResultType enum value. One of the following:
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.

Return Value

Type: ConnectApi.ZoneSearchPage

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchInZone(communityId, zoneId, q, filter, pageParam, pageSize)

Search a page of articles or questions in a zone.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Available to Guest Users

37.0

Requires Chatter

Yes

Signature

public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String pageParam, Integer pageSize)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
A ZoneSearchResultType enum value. One of the following:
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
pageParam
Type: String
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize
Type: Integer
Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ZoneSearchPage

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchInZone(communityId, zoneId, q, filter, language)

Search articles or questions in a zone, and specify the language of the results.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

36.0

Available to Guest Users

37.0

Requires Chatter

Yes

Signature

public static ConnectApi.ZoneSearchPage searchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String language)

Parameters

communityId
Type: String
ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
language
Type: String
The language of the articles or questions. The value must be a Salesforce supported locale code.

Return Value

Type: ConnectApi.ZoneSearchPage

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Zones Test Methods

These test methods are for Zones. All methods are static.

For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.

setTestSearchInZone(communityId, zoneId, q, filter, result)

Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter) is called in a test context. Use the method with the same parameters or you receive an exception.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Signature

public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, ConnectApi.ZoneSearchPage result)

Parameters

communityId
Type: String
Use either the ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
The ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
A ZoneSearchResultType enum value. One of the following:
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
result
Type: ConnectApi.ZoneSearchPage
The object containing test data.

Return Value

Type: Void

setTestSearchInZone(communityId, zoneId, q, filter, pageParam, pageSize, result)

Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, pageParam, pageSize) is called in a test context. Use the method with the same parameters or you receive an exception.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

29.0

Signature

public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String pageParam, Integer pageSize, ConnectApi.ZoneSearchPage result)

Parameters

communityId
Type: String
Use either the ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
The ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
A ZoneSearchResultType enum value. One of the following:
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
pageParam
Type: String
Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize
Type: Integer
Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
result
Type: ConnectApi.ZoneSearchPage
The object containing test data.

Return Value

Type: Void

setTestSearchInZone(communityId, zoneId, q, filter, language, result)

Register a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, language) is called in a test context. Use the method with the same parameters or you receive an exception.

With the Spring ’18 release, Salesforce no longer supports Chatter Answers. Users of Chatter Answers can post, answer, comment, or view existing Chatter Answers data, but support and updates are scheduled to end. We recommend transitioning to Chatter Questions. For more information, see End of Support for Chatter Answers in Spring ’18.

Note

API Version

36.0

Signature

public static Void setTestSearchInZone(String communityId, String zoneId, String q, ConnectApi.ZoneSearchResultType filter, String language, ConnectApi.ZoneSearchPage result)

Parameters

communityId
Type: String
Use either the ID for an Experience Cloud site, internal, or null.
zoneId
Type: String
The ID of a zone.
q
Type: String
Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
filter
Type: ConnectApi.ZoneSearchResultType
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
language
Type: String
The language of the articles or questions. The value must be a Salesforce supported locale code. In an <apex:page>, the default value is the language of the page. Otherwise, the default value is the user's locale.
result
Type: ConnectApi.ZoneSearchPage
The object containing test data.

Return Value

Type: Void