Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Zones Class
Namespace
Zones Methods
All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.
getZone(communityId, zoneId)
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)
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)
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)
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
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)
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
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)
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
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
For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.
setTestSearchInZone(communityId, zoneId, q, filter, result)
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)
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)
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