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
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom 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
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
KnowledgeSuggestionFilter Class
KnowledgeSuggestionFilter Methods
QuestionSuggestionFilter Class
SearchResult Class
SearchResults Class
SuggestionOption Class
SuggestionResult Class
SuggestionResults Class
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

KnowledgeSuggestionFilter Class

Filter settings that narrow the results from a call to System.Search.suggest(searchQuery, sObjectType, options) when the SOSL search query contains a KnowledgeArticleVersion object.

Namespace

Search

KnowledgeSuggestionFilter Methods

The following are methods for KnowledgeSuggestionFilter.

addArticleType(articleType)

Adds a filter that narrows suggestion results to display the specified article type. This filter is optional.

Signature

public void addArticleType(String articleType)

Parameters

articleType
Type: String
A three-character ID prefix indicating the desired article type.

Return Value

Type: void

Usage

To add more than 1 article type, call the method multiple times.

addDataCategory(dataCategoryGroupName, dataCategoryName)

Adds a filter that narrows suggestion results to display articles in the specified data category. This filter is optional.

Signature

public void addDataCategory(String dataCategoryGroupName, String dataCategoryName)

Parameters

dataCategoryGroupName
Type: String
The name of the data category group
dataCategoryName
Type: String
The name of the data category.

Return Value

Type: void

Usage

To set multiple data categories, call the method multiple times. The name of the data category group and name of the data category for desired articles, expressed as a mapping, for example, Search.KnowledgeSuggestionFilter.addDataCategory('Regions', 'Asia').

addTopic(topic)

Specifies the article topic to return. This filter is optional.

Signature

public void addTopic(String topic)

Parameters

addTopic
Type: String
The name of the article topic.

Return Value

Type: void

Usage

To add more than 1 article topic, call the method multiple times.

setChannel(channelName)

Sets a channel to narrow the suggestion results to articles in the specified channel. This filter is optional.

Signature

public void setChannel(String channelName)

Parameters

channelName
Type: String
The name of a channel. Valid values are:
  • AllChannels–Visible in all channels the user has access to
  • App–Visible in the internal Salesforce Knowledge application
  • Pkb–Visible in the public knowledge base
  • Csp–Visible in the Customer Portal
  • Prm–Visible in the Partner Portal
If channel isn’t specified, the default value is determined by the type of user.
  • Pkb for a guest user
  • Csp for a Customer Portal user
  • Prm for a Partner Portal user
  • App for any other type of user
If channel is specified, the specified value may not be the actual value requested, because of certain requirements.
  • For guest, Customer Portal, and Partner Portal users, the specified value must match the default value for each user type. If the values don’t match or AllChannels is specified, then App replaces the specified value.
  • For all users other than guest, Customer Portal, and Partner Portal users:
    • If Pkb, Csp, Prm, or App are specified, then the specified value is used.
    • If AllChannels is specified, then App replaces the specified value.

Return Value

Type: void

setDataCategories(dataCategoryFilters)

Adds filters that narrow suggestion results to display articles in the specified data categories. Use this method to set multiple data category group and name pairs in one call. This filter is optional.

Signature

public void setDataCategories(Map dataCategoryFilters)

Parameters

dataCategoryFilters
Type: Map
A map of data category group and data category name pairs.

Return Value

Type: void

setLanguage(localeCode)

Sets a language to narrow the suggestion results to display articles in that language. This filter value is required in calls to System.Search.suggest(String, String, Search.SuggestionOption).

Signature

public void setLanguage(String localeCode)

Parameters

localeCode
Type: String
A locale code. For example, 'en_US' (English–United States), or 'es' (Spanish).

Return Value

Type: void

setPublishStatus(publishStatus)

Sets a publish status to narrow the suggestion results to display articles with that status. This filter value is required in calls to System.Search.suggest(String, String, Search.SuggestionOption).

Signature

public void setPublishStatus(String publishStatus)

Parameters

publishStatus
Type: String
A publish status. Valid values are:
  • Draft–Articles aren’t published in Salesforce Knowledge.
  • Online–Articles are published in Salesforce Knowledge.
  • Archived–Articles aren’t published and are available in Archived Articles view.

setValidationStatus(validationStatus)

Sets a validation status to narrow the suggestion results to display articles with that status. This filter is optional.

Signature

public void setValidationStatus(String validationStatus)

Parameters

validationStatus
Type: String
An article validation status. These values are available in the ValidationStatus field on the KnowledgeArticleVersion object.

Return Value

Type: void