Enables scripted content fragments to use Search
Methods
Create
Usage
#set($searchResultResponse = $core_v2_searchResult.Create($content, $contentId, $contentType, $contentUrl, $date, $roles, $title))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| content | string |
Content | Required | ||
| contentId | string |
Content Id | Required | ||
| contentType | string |
Content Type | Required | ||
| contentUrl | string |
Content Url | Required | ||
| date | DateTime |
Date | Required | ||
| roles | string |
Roles | Required | ||
| title | string |
Title | Required |
Return Type
Create
Usage
#set($searchResultResponse = $core_v2_searchResult.Create($content, $contentId, $contentType, $contentUrl, $date, $roles, $title, "%{Collapse = $collapseArg, CreatedBy = $createdByArg, CustomFields = $customFieldsArg, EditedBy = $editedByArg, GroupId = $groupIdArg, Rating = $ratingArg, SectionId = $sectionIdArg, Tags = $tagsArg, ThreadId = $threadIdArg, UserId = $userIdArg, Username = $usernameArg, WikiId = $wikiIdArg}"))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| content | string |
Content | Required | ||
| contentId | string |
Content Id | Required | ||
| contentType | string |
Content Type | Required | ||
| contentUrl | string |
Content Url | Required | ||
| date | DateTime |
Date | Required | ||
| roles | string |
Roles | Required | ||
| title | string |
Title | Required | ||
| Collapse | bool |
Collapse | Optional | ||
| CreatedBy | string |
Created By | Optional | ||
| CustomFields | List<SearchField> |
Custom Fields | Optional | ||
| EditedBy | string |
Edited By | Optional | ||
| GroupId | int |
Group Id | Optional | ||
| Rating | double |
Rating | Optional | ||
| SectionId | int |
Section Id | Optional | ||
| Tags | string |
Tags | Optional | ||
| ThreadId | int |
Thread Id | Optional | ||
| UserId | int |
User Id | Optional | ||
| Username | string |
Username | Optional | ||
| WikiId | int |
Wiki Id | Optional |
Return Type
Delete
Usage
#set($additionalInfoResponse = $core_v2_searchResult.Delete($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | string |
Id | Required |
Return Type
Get
Get a SearchResult by Id
Usage
#set($searchResultResponse = $core_v2_searchResult.Get($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | string |
Id | Required |
Return Type
GetRelatedContent
Searches for related content
Usage
#set($searchResultsResponse = $core_v2_searchResult.GetRelatedContent($searchUniqueId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| searchUniqueId | string |
An entity's unique search id, available as a property of entities | Required |
Return Type
GetRelatedContent
Searches for related content
Usage
#set($searchResultsResponse = $core_v2_searchResult.GetRelatedContent($searchUniqueId, "%{Filters = $filtersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Sort = $sortArg}"))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| searchUniqueId | string |
An entity's unique search id, available as a property of entities | Required | ||
| Filters | string |
Filters. | Optional | ||
| PageIndex | int |
Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int |
Specify the number of results to return per page. | Optional | 20 | |
| Sort | string |
Sort | Optional | date, date asc, date desc, titlesort, titlesort asc, titlesort desc |
Return Type
IsSearchable
Usage
#set($booleanResponse = $core_v2_searchResult.IsSearchable($contentTypeId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentTypeId | Guid |
Content Type Id | Required |
Return Type
bool
List
Perform a search with query parameters.
Usage
#set($searchResultsResponse = $core_v2_searchResult.List("%{ApplicationId = $applicationIdArg, Collapse = $collapseArg, ContainerId = $containerIdArg, DateRangeFacets = $dateRangeFacetsArg, DateRangeFilters = $dateRangeFiltersArg, EndDate = $endDateArg, FieldFacets = $fieldFacetsArg, FieldFilters = $fieldFiltersArg, Filters = $filtersArg, IsApplication = $isApplicationArg, IsContainer = $isContainerArg, IsContent = $isContentArg, LogicallyOrTags = $logicallyOrTagsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Query = $queryArg, Sort = $sortArg, StartDate = $startDateArg, Tags = $tagsArg}"))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| ApplicationId | Guid |
Application Id | Optional | ||
| Collapse | bool |
Collapse | Optional | False | |
| ContainerId | Guid |
Container Id | Optional | ||
| DateRangeFacets | string |
Date Range Facets. | Optional | ||
| DateRangeFilters | string |
Date Range Filters. | Optional | ||
| EndDate | DateTime |
End Date | Optional | ||
| FieldFacets | string |
Field Facets. | Optional | ||
| FieldFilters | string |
Field Filters. | Optional | ||
| Filters | string |
Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | ||
| IsApplication | bool |
Is Application | Optional | ||
| IsContainer | bool |
Is Container | Optional | ||
| IsContent | bool |
Is Content | Optional | ||
| LogicallyOrTags | bool |
Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags. | Optional | ||
| PageIndex | int |
Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int |
Specify the number of results to return per page. | Optional | 20 | |
| Query | string |
Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | Optional | ||
| Sort | string |
Sort | Optional | date, date asc, date desc, titlesort, titlesort asc, titlesort desc | |
| StartDate | DateTime |
Start Date | Optional | ||
| Tags | string |
Comma delimited list of tags. | Optional |
Return Type
Update
Usage
#set($searchResultResponse = $core_v2_searchResult.Update($id, "%{Collapse = $collapseArg, Content = $contentArg, ContentId = $contentIdArg, ContentType = $contentTypeArg, ContentUrl = $contentUrlArg, CreatedBy = $createdByArg, CustomFields = $customFieldsArg, Date = $dateArg, EditedBy = $editedByArg, GroupId = $groupIdArg, Rating = $ratingArg, Roles = $rolesArg, SectionId = $sectionIdArg, Tags = $tagsArg, ThreadId = $threadIdArg, Title = $titleArg, UserId = $userIdArg, Username = $usernameArg, WikiId = $wikiIdArg}"))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | string |
Id | Required | ||
| Collapse | bool |
Collapse | Optional | ||
| Content | string |
Content | Optional | ||
| ContentId | string |
Content Id | Optional | ||
| ContentType | string |
Content Type | Optional | ||
| ContentUrl | string |
Content Url | Optional | ||
| CreatedBy | string |
Created By | Optional | ||
| CustomFields | List<SearchField> |
Custom Fields | Optional | ||
| Date | DateTime |
Date | Optional | ||
| EditedBy | string |
Edited By | Optional | ||
| GroupId | int |
Group Id | Optional | ||
| Rating | double |
Rating | Optional | ||
| Roles | string |
Roles | Optional | ||
| SectionId | int |
Section Id | Optional | ||
| Tags | string |
Tags | Optional | ||
| ThreadId | int |
Thread Id | Optional | ||
| Title | string |
Title | Optional | ||
| UserId | int |
User Id | Optional | ||
| Username | string |
Username | Optional | ||
| WikiId | int |
Wiki Id | Optional |