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
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
AsyncDeleteCallback Class
AsyncSaveCallback Class
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
DataSourceUtil Class
DataType Enum
DeleteContext Class
DeleteResult Class
Filter Class
FilterType Enum
IdentityType Enum
Order Class
OrderDirection Enum
Provider Class
QueryAggregation Enum
QueryContext Class
QueryUtils Class
ReadContext Class
SearchContext Class
SearchContext Constructors
SearchContext Properties
SearchUtils Class
Table Class
TableResult Class
TableSelection Class
UpsertContext Class
UpsertResult Class
DataSource Exceptions
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow 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
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

SearchContext Class

An instance of SearchContext is provided to the search method on your DataSource.Connection class. The instance corresponds to a search or SOSL request.

Namespace

DataSource

SearchContext Constructors

The following are constructors for SearchContext.

SearchContext(metadata, offset, maxResults, tableSelections, searchPhrase)

Creates an instance of the SearchContext class with the specified parameter values.

Signature

public SearchContext(List<DataSource.Table> metadata, Integer offset, Integer maxResults, List<DataSource.TableSelection> tableSelections, String searchPhrase)

Parameters

  • metadata:

    Type: List<DataSource.Table>

    List of table metadata that describes the external system’s tables to query.

  • offset:

    Type: Integer

    Specifies the starting row offset into the query’s result set.

  • maxResults:

    Type: Integer

    Specifies the maximum number of rows to return in each batch.

  • tableSelections:

    Type: List<DataSource.TableSelection>

    List of queries and their details. The details represent the FROM, ORDER BY, SELECT, and WHERE clauses in each SOQL or SOSL query.

  • searchPhrase:

    Type: String

    The user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed.

SearchContext()

Creates an instance of the SearchContext class.

Signature

public SearchContext()

SearchContext Properties

The following are properties for SearchContext.

searchPhrase

The user-entered search string as a case-sensitive single phrase, with all non-alphanumeric characters removed.

Signature

public String searchPhrase {get; set;}

Property Value

Type: String

tableSelections

List of queries and their details. The details represent the FROM, ORDER BY, SELECT, and WHERE clauses in each SOQL or SOSL query.

Signature

public List<DataSource.TableSelection> tableSelections {get; set;}

Property Value

Type: List<DataSource.TableSelection>