PageCommandsServicesQuickSearchContentItems Method
|
Searches for pages, assets, asset folders by the initial characters in their names
Namespace:
IngeniuxCMService
Assembly:
IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntax public XHRServiceResponseGeneric<ContentQuickSearchData[]> QuickSearchContentItems(
string search,
string existingIds,
bool includePages,
bool includeAssets,
bool includeAssetFolders,
bool excludeLocale = false
)
Public Function QuickSearchContentItems (
search As String,
existingIds As String,
includePages As Boolean,
includeAssets As Boolean,
includeAssetFolders As Boolean,
Optional excludeLocale As Boolean = false
) As XHRServiceResponseGeneric(Of ContentQuickSearchData())
public:
virtual XHRServiceResponseGeneric<array<ContentQuickSearchData^>^>^ QuickSearchContentItems(
String^ search,
String^ existingIds,
bool includePages,
bool includeAssets,
bool includeAssetFolders,
bool excludeLocale = false
) sealed
abstract QuickSearchContentItems :
search : string *
existingIds : string *
includePages : bool *
includeAssets : bool *
includeAssetFolders : bool *
?excludeLocale : bool
(* Defaults:
let _excludeLocale = defaultArg excludeLocale false
*)
-> XHRServiceResponseGeneric<ContentQuickSearchData[]>
override QuickSearchContentItems :
search : string *
existingIds : string *
includePages : bool *
includeAssets : bool *
includeAssetFolders : bool *
?excludeLocale : bool
(* Defaults:
let _excludeLocale = defaultArg excludeLocale false
*)
-> XHRServiceResponseGeneric<ContentQuickSearchData[]>
Parameters
- search
- Type: SystemString
Initial characters in Page names, not case-sensitive - existingIds
- Type: SystemString
Pipe-delimited list of page ids that will not show up on the returned list - includePages
- Type: SystemBoolean
Whether to include pages in result - includeAssets
- Type: SystemBoolean
Whether to include assets in result - includeAssetFolders
- Type: SystemBoolean
Whether to include asset folders in result - excludeLocale (Optional)
- Type: SystemBoolean
Whether to exclude locale information in result entry labels
Return Value
Type:
XHRServiceResponseGenericContentQuickSearchData2-axis array of found content items
Examples Sample JSON return
{
"ContentFreezeEndTime": "",
"ContentFreezeStartTime": "",
"code": 0,
"error": null,
"message": [
[
"test (x61)",
"x61",
"1"
],
[
"test 1 (x60) (English (United States))",
"x60",
"2"
],
[
"test_pattern (a/183)",
"a/183",
"3"
],
[
"test_pattern (a/186)",
"a/186",
"3"
],
[
"test1 (af/22)",
"af/22",
"1"
],
[
"test1 (x62)",
"x62",
"2"
]
]
}
See Also