SFSDKSoslBuilder Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | SFSDKSoslBuilder.h |
Query Builder
+ withSearchTerm:
A builder to help create a SOSL statement.
+ (SFSDKSoslBuilder *)withSearchTerm:(NSString *)searchTermParameters
searchTerm |
text or word phrases to search for |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
– searchGroup:
A builder to help create a SOSL statement.
- (SFSDKSoslBuilder *)searchGroup:(NSString *)searchGroupParameters
searchGroup |
scope of fields to search. Values may be: ALL FIELDS, NAME FIELDS, EMAIL FIELDS, PHONE FIELDS, SIDEBAR FIELDS |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
– returning:
A builder to help create a SOSL statement.
- (SFSDKSoslBuilder *)returning:(SFSDKSoslReturningBuilder *)returningSpecParameters
returningSpec |
information to return in the search result. List of one or more objects and, within each object, list of one or more fields, with optional values to filter against. If unspecified, then the search results contain the IDs of all objects found |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
– divisionFilter:
A builder to help create a SOSL statement.
- (SFSDKSoslBuilder *)divisionFilter:(NSString *)divisionFilterParameters
divisionFilter |
if an organization uses divisions, filters all search results based on values for the Division field |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
– dataCategory:
A builder to help create a SOSL statement.
- (SFSDKSoslBuilder *)dataCategory:(NSString *)dataCategoryParameters
dataCategory |
if an organization uses Salesforce Knowledge articles or answers, filters all search results based on one or more data categories |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
– limit:
A builder to help create a SOSL statement.
- (SFSDKSoslBuilder *)limit:(NSInteger)limitParameters
limit |
the maximum number of rows returned in the text query, up to 200. If unspecified, the default is 200, the largest number of rows that can be returned |
|---|
Return Value
the builder
Declared In
SFSDKSoslBuilder.h
Query String Generation
– encodeAndBuild
Builds an encoded query from the builder.
- (NSString *)encodeAndBuildReturn Value
the built query
Declared In
SFSDKSoslBuilder.h
– encodeAndBuildWithPath:
Builds an enoded query from the builder.
- (NSString *)encodeAndBuildWithPath:(NSString *)pathParameters
path |
the path to build the query for |
|---|
Return Value
the built query
Declared In
SFSDKSoslBuilder.h
– buildWithPath:
Builds a raw (unencoded) query from the builder.
- (NSString *)buildWithPath:(NSString *)pathParameters
path |
the path to build the query for |
|---|
Return Value
the built query
Declared In
SFSDKSoslBuilder.h
– build
Builds a raw (unencoded) query from the builder.
- (nullable NSString *)buildReturn Value
the built query
Declared In
SFSDKSoslBuilder.h