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
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Communities Class
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
ExternalEmailServices Class
Knowledge Class
ManagedTopics Class
Mentions Class
Organization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
SalesforceInbox Class
Topics Class
UserProfiles Class
Wave Class
Zones Class
Zones Methods
Zones Test Methods
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

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.

Namespace

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

ConnectApi

Zones Methods

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

getZone(communityId, zoneId)

Returns a specific zone based on the zone ID.

API Version

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

29.0

Requires Chatter

No

Signature

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

Parameters

communityId
Type: String
Use either the ID for a community, internal, or null.
zoneId
Type: String
The ID of a zone.

Return Value

Type: ConnectApi.Zone

getZones(communityId)

Returns a paginated list of zones.

API Version

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

29.0

Requires Chatter

No

Signature

public static ConnectApi.ZonePage getZones(String communityId)

Parameters

communityId
Type: String
Use either the ID for a community, internal, or null.

Return Value

Type: ConnectApi.ZonePage

getZones(communityId, pageParam, pageSize)

Returns a paginated list of zones with the specified page and page size.

API Version

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

29.0

Requires Chatter

No

Signature

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

Parameters

communityId
Type: String
Use either the ID for a community, internal, or null.
pageParam
Type: Integer
Specifies the 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 a zone by keyword. Specify whether to search articles or questions.

API Version

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

29.0

Available to Guest Users

37.0

Requires Chatter

No

Signature

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

Parameters

communityId
Type: String
Use either the ID for a community, internal, or null.
zoneId
Type: String
zoneId—The ID of a zone.
q
Type: String
q—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 zone by keyword. Specify whether to search articles or questions and specify the page of information to view and the page size.

API Version

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

29.0

Available to Guest Users

37.0

Requires Chatter

No

Signature

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

Parameters

communityId
Type: String
Use either the ID for a community, internal, or null.
zoneId
Type: String
zoneId—The ID of a zone.
q
Type: String
q—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.

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 a zone by keyword. Specify the language of the results and specify whether to search articles or questions.

API Version

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

36.0

Available to Guest Users

37.0

Requires Chatter

No

Signature

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

Parameters

communityId
Type: String
Use either the ID for a community, 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.

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

The following are the test methods 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)

Registers a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter) is called in a test context.

API Version

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

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 a community, internal, or null.
zoneId
Type: String
zoneId—The ID of a zone.
q
Type: String
q—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)

Registers a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, pageParam, pageSize) is called in a test context.

API Version

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

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 a community, internal, or null.
zoneId
Type: String
zoneId—The ID of a zone.
q
Type: String
q—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)

Registers a ConnectApi.ZoneSearchPage object to be returned when searchInZone(communityId, zoneId, q, filter, language) is called in a test context.

API Version

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

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 a community, 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