Force.com Apex Code Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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

ConnectApi

Zones Methods

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

getZone(String, String)

Returns a specific zone based on the zone ID.

API Version

29.0

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

Returns a paginated list of zones.

API Version

29.0

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(String, Integer, Integer)

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

API Version

29.0

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 between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.Zone

searchInZone(String, String, String, ConnectApi.ZoneSearchResultType)

Search a zone by keyword. Specify whether to search articles or questions.

API Version

29.0

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

searchInZone(String, String, String, ConnectApi.ZoneSearchResultType, String, Integer)

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

29.0

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 between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ZoneSearchPage

setTestSearchInZone(String, String, String, ConnectApi.ZoneSearchResultType, ConnectApi.ZoneSearchPage)

Registers a ConnectApi.ZoneSearchPage object to be returned when searchInZone(String, String, String, ConnectApi.ZoneSearchResultType) is called in a test context.

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 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(String, String, String, ConnectApi.ZoneSearchResultType, String, Integer, ConnectApi.ZoneSearchPage)

Registers a ConnectApi.ZoneSearchPage object to be returned when searchInZone(String, String, String, ConnectApi.ZoneSearchResultType, String, Integer) is called in a test context.

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 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 between 1 and 100. If you pass in null, the default size is 25.
result
Type: ConnectApi.ZoneSearchPage
The object containing test data.

Return Value

Type: Void