Apex Reference Guide

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
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex 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
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
KnowledgeSuggestionFilter Class
QuestionSuggestionFilter Class
SearchResult Class
SearchResults Class
SuggestionOption Class
SuggestionOption Methods
SuggestionResult Class
SuggestionResults Class
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: 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.

SuggestionOption Class

Options that narrow record and article suggestion results returned from a call to System.Search.suggest(String, String, Search.SuggestionOption).

Namespace

Search

SuggestionOption Methods

The following are methods for SuggestionOption.

setFilter(knowledgeSuggestionFilter)

Set filters that narrow Salesforce Knowledge article results in a call to System.Search.suggest(String, String, Search.SuggestionOption).

Signature

public void setFilter(Search.KnowledegeSuggestionFilter knowledgeSuggestionFilter)

Parameters

Return Value

Type: void

Usage

1Search.KnowledgeSuggestionFilter filters = new Search.KnowledgeSuggestionFilter(); 
2filters.setLanguage('en_US'); 
3filters.setPublishStatus('Online'); 
4filters.setChannel('app'); 
5
6Search.SuggestionOption options = new Search.SuggestionOption(); 
7options.setFilter(filters); 
8
9Search.SuggestionResults suggestionResults = Search.suggest('all', 'KnowledgeArticleVersion', options); 
10
11for (Search.SuggestionResult searchResult : suggestionResults.getSuggestionResults()) {     
12  KnowledgeArticleVersion article = (KnowledgeArticleVersion)searchResult.getSObject();   
13  System.debug(article.title); 
14}

setLimit(limit)

The maximum number of record or article suggestions to retrieve.

Signature

public void setLimit(Integer limit)

Parameters

  • limit: Type: Integer The maximum number of record or article suggestions to retrieve.

Return Value

Type: void

Usage

By default, the System.Search.suggest(String, String, Search.SuggestionOption) method returns the 5 most relevant results. However, if your query is broad, it could match more than 5 results. If Search.SuggestionResults.hasMoreResults() returns true, there are more than 5 results. To retrieve them, call setLimit(Integer) to increase the number of suggestions results.
1Search.SuggestionOption option = new Search.SuggestionOption();
2option.setLimit(10);
3Search.suggest('my query', 'mySObjectType', option);